Skip to content
Bryan Housel edited this page Nov 20, 2024 · 2 revisions

Each resource must have a type value. The type mostly controls what icon and default text that the resource can use.

Some resource types also expect a account property.

Here is the current list of supported resource types:

Type Icon Description
aparat An Aparat video channel.
account should contain the channel name.
bluesky A Bluesky account.
account should contain account handle, including domain (without leading '@', e.g. 'openstreetmap.bsky.social').
discord A Discord chat server.
account should contain the server name.
discourse A Discourse forum.
For forums hosted on https://community.openstreetmap.org, account should contain the forum identifier number or string.
facebook A Facebook group/account.
account should contain the group/account name.
fediverse A generic social website that shares its content via federation, see Fediverse for examples.
forum A generic web forum.
github A GitHub organization.
account should contain the organization name.
gitlab A GitLab organization.
account should contain the organization name.
group A generic non-OpenStreetMap local group with a url (e.g. Maptime chapter).
instagram An Instagram account.
account should contain account name.
irc An IRC channel.
url should be a clickable web join link, server details can go in description.
account should contain the channel name (without leading '#').
linkedin A LinkedIn organization.
account should contain the organization name.
mailinglist A mailing list.
url should be a link to the listinfo page, e.g. https://lists.openstreetmap.org/listinfo/talk-et.
account should contain the mailing list name (e.g. 'talk-et').
mastodon A Mastodon account.
url should be a link to the server and account page, e.g. https://en.osm.town/@osm_be
matrix A Matrix chat, e.g. Riot Chat.
For resources available via the matrix.org server, account should contain the room or community identifier (with leading '#' or '+' as needed).
meetup A Meetup group.
account should contain the group account name.
newsletter A newsletter that people can subscribe to.
url should link to information about the newsletter.
osm A url for an OpenStreetMap group.
osm-lc A url for an official OpenStreetMap Local Chapter.
reddit A subreddit on Reddit.
account should contain the subreddit name (without leading '/r/').
signal A Signal group chat.
url should contain the Group link.
slack A Slack workspace.
url should link to the workspace itself, and signupUrl can link to an inviter service (see example above).
telegram A Telegram channel/group.
account should contain the channel/group name.
threads A Threads account.
account should contain account name (without leading '@').
tiktok A TikTok account.
account should contain account name (without leading '@').
twitter or x An 𝕏 account.
account should contain account name (without leading '@').
Note that twitter and x types do the same thing. It doesn't matter which one you use.
url A generic catchall for anything with a url.
wiki An OpenStreetMap WikiProject page
xmpp An XMPP/Jabber channel.
url should be a clickable web join link, server details can go in description.
youthmappers A YouthMappers chapter.
youtube A YouTube channel.
account should contain the channel name.
zulip A Zulip group chat.
url should contain the group chat link.

Home

For Contributors

For Developers

Information for developers using the osm-community-index in another project.

For Maintainers

Information for maintainers, including how to clone and build the project.

 

Clone this wiki locally