-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Beta Docs “our-platforms” (#145)
* Update Beta Docs “our-platforms” × 3 Co-authored-by: Faruk Ateş <[email protected]>
- Loading branch information
1 parent
cf635c8
commit e1ad622
Showing
1 changed file
with
35 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,70 +1,73 @@ | ||
| --- | ||
| title: Our Platforms | ||
| description: Platforms our internal community use (like Discord, Discourse, or | ||
| GitHub), how they impact Cred, and the basic social norms of using them. | ||
| description: Platforms our internal community uses (like Discord, Discourse, or | ||
| GitHub), how they impact cred, and the basic social norms of using them. | ||
| --- | ||
| SourceCred operates on a few different platforms that serve the needs of our internal community. Joining the platforms where we do our daily coordination and socializing will both plug you into the conversation and be the most effective way to get up to speed on what's happening in the project. | ||
| SourceCred operates on a few different platforms that serve the needs of our internal community: **Discord** for daily coordination and socializing, **Discourse** for proposals and larger community conversations, **Roam** for research and notes, and **GitHub** for code and project management. Join these to plug into the ongoing SourceCred conversation; it’s the most effective way to get up to speed on what’s happening in the project. | ||
|
|
||
| Below you'll find a description of the major platforms our community uses to work and hang out together, as well as notes about how Cred flows, and an invitation link to each. | ||
| Learn more about how we use these major platforms below, and how Cred flows within and between each. | ||
|
|
||
| # Discord | ||
|
|
||
| \[Invite Button] | ||
| ## [Discord](https://sourcecred.io/discord) | ||
|
|
||
| Discord is the main hub of our community when it comes to daily conversations and coordination. This is where you'll have a chance to ask questions, share ideas, see our social norms in action, or shoot the breeze with other community members in the project. | ||
| Discord is the main hub of our community when it comes to daily conversations and coordination. This is where you’ll have a chance to ask questions, share ideas, see our social norms in action, or shoot the breeze with other community members in the project. | ||
|
|
||
| ##### Discord and Cred: | ||
| #### Discord and Cred | ||
|
|
||
| In Discord, Cred is Minted through emoji reactions. Any time you are on the Discord chats and you see a comment which you find particularly useful, insightful, interesting or valuable, give it an emoji. Every emoji in Discord Mints a small amount of Cred, so you can express yourself with any emoji image you like, and if you really felt something was great then put multiple emojis on it! The SourceCred logo is a special emoji which is worth 16 regular emojis when used on a Discord message. Use the SourceCred emoji for comments you felt were deeply valuable to the project as a whole. If your intention is not to Mint Cred but simply to use fun emojis, you can always add your emojis as a reply in the channel instead of as a message reaction. | ||
| In Discord, Cred is minted through emoji reactions. Any time you are on the Discord chats and you see a comment which you find particularly useful, insightful, interesting, or valuable give it an emoji. Every emoji in Discord mints a small amount of Cred, so you can express yourself with any emoji image you like. If you feel strongly that something was really great, then put multiple emojis on it! | ||
|
|
||
| Note that only emojis in public channels will Mint Cred. Direct messages and role-based access channels do not Mint Cred regardless of emoji reaction use. | ||
| The SourceCred logo is a special emoji which is worth **16** regular emojis when used on a Discord message. Use the SourceCred emoji for comments you felt were particularly valuable to the project as a whole. If your intention is not to mint Cred but simply to use fun emojis, you can always add your emojis as a reply in the channel instead of as a message reaction. | ||
|
|
||
| ##### Special Channels: | ||
| **Note:** only emojis in public channels will mint Cred. Direct messages and role-based access channels do not mint Cred regardless of emoji reaction use. | ||
|
|
||
| It's worth mentioning that in the SourceCred Discord has two special channels that affect how Cred flows. | ||
| #### Special Channels | ||
|
|
||
| The **\#didathing** channel is a channel that helps catch contributions that our algorithm is not complete enough to see yet. Any time you complete an action that is valuable to the community, but is not on Discourse or GitHub, you can post in #didathing describing what you accomplished, tagging any other contributors involved, and linking to any useful notes/artifacts of your work. This allows the community to give emoji reactions and therefore Mint some up-front Cred for that contribution even if the algorithm can't see it. Post in #didathing whenever you make a contribution you know the algorithm won't see. Whenever you see someone post a contribution in #didathing that you feel is valuable, give it some emoji reactions! The flow and norms of #didathing will become more clear the longer you spend time with us. | ||
| The SourceCred Discord has two special channels that affect how Cred flows. | ||
|
|
||
| The **\#props** channel is a compliment to #didathing. Instead of posting about your own contribution, you post giving "props" to someone else in the community for a contribution they made that won't be seen by the algorithm. To do so, describe what they did and tag them in the message so that other community members can Mint Cred with emoji reactions. | ||
| The **\#didathing** channel helps to catch contributions that our algorithm is not complete enough to see yet. Any time you complete an action that is valuable to the community but is not on Discourse or GitHub, you can post in **\#didathing** describing what you accomplished. Make sure to tag any other contributors involved, and link to any useful notes or artifacts of your work. This allows the community to give emoji reactions and thereby mint some up-front Cred for that contribution even if the algorithm couldn’t see it. Whenever you see someone post a contribution in **\#didathing** which you feel was valuable, give it some emoji reactions! The flow and norms of **\#didathing** will become more clear the longer you spend time with us. | ||
|
|
||
| # GitHub | ||
| The **\#props** channel is a compliment to #didathing. Instead of posting about your own contribution, you post giving “props” to someone else in the community for _their_ contribution which you know won’t be seen by the algorithm. To do so, describe what they did and tag them in the message so that other community members can mint Cred with emoji reactions. A good example is when someone helps you out in a private DM; afterward, you might post to **\#props** saying e.g. “Props to @LBS for explaining the various SourceCred channels to me!” | ||
|
|
||
| \[Invite Button] | ||
| [Join our Discord server](https://sourcecred.io/discord). | ||
|
|
||
| GitHub is where our software engineers and other devs organize their coding efforts. If you're code-savvy, come poke through our codebase, learn about our atomic coding philosophy, and see if there are any good first issues for you to get started on. | ||
|
|
||
| As you learn the norms of the repo and start to take on some of your first issues, our devs with high context are always keeping an eye on the "#tech-support" channel and will be happy to answer your questions. | ||
| ## [GitHub](https://github.com/sourcecred/) | ||
|
|
||
| ##### GitHub and Cred: | ||
| GitHub is where our software engineers and other devs organize their coding efforts. If you are code-savvy, come poke through our codebase, learn about our atomic coding philosophy, and see if there are any good first issues for you to get started on! | ||
|
|
||
| As you learn the norms of the repo and start to take on some of your first issues, our devs with high context are always keeping an eye on the **\#tech-support** channel on [Discord](#discord) and will be happy to answer your questions. | ||
|
|
||
| #### GitHub and Cred | ||
|
|
||
| *Need input from Devs* | ||
|
|
||
| ##### Atomic Coding Philosophy: | ||
| #### Atomic Coding Philosophy | ||
|
|
||
| *Need input from Devs* | ||
|
|
||
| # Discourse | ||
| [Explore our public GitHub repository](https://github.com/sourcecred/) | ||
|
|
||
| \[Invite Button] | ||
|
|
||
| The Discourse forums are where we expand on ideas brought up in calls, in Discord chats, etc. Using the forums to write full posts (aka "topics") provides more permanence and opportunity for feedback. Eventually, these ideas may become polished into documentation. | ||
| ## [Discourse](https://discourse.sourcecred.io/) | ||
|
|
||
| Our Discourse is currently a bit of a jungle that requires a determined heart the first few times you venture in. While there are certainly some nuggets of gold to be found, the forums as a whole are difficult to parse through due to organization issues. Improvements are on the way, but until then you can use the "Latest" button to find the most recent topics, or simply follow links you see in the Discord chats to individual posts. | ||
| The Discourse forums are where we expand on ideas brought up in calls or on the Discord chats, etc. Write full posts (aka “topics”) on the forums to provide more permanence and opportunity for feedback. Eventually, those ideas may become polished into features and/or documentation. | ||
|
|
||
| ##### Discourse and Cred: | ||
| Our Discourse is currently a bit of a jungle that requires a determined heart to venture into. While there are certainly some nuggets of gold to be found, the forums as a whole are difficult to parse through due to organization issues. Improvements are on the way, but until then you can use the "Latest" button to find the most recent topics, or simply follow links you see in the Discord chats to individual posts. | ||
|
|
||
| Cred is Minted based on "likes" in Discourse. Any time you read a topic or a comment in Discourse and use the interface to give it a little heart (aka a "like"), a small amount of Cred is created and flowed to the author of that topic or comment and anyone the author tagged in their topic or comment. Show the love and like something whenever you find it valuable! | ||
| #### Discourse and Cred | ||
|
|
||
| # Roam | ||
| Cred is minted based on “likes” in Discourse. Any time you read a topic or a comment in Discourse and use the interface to give it a little heart (a.k.a. a “like”), a small amount of Cred is created and flowed to the author of that topic or comment, as well as anyone the author tagged in it. Show the love and like something whenever you find it valuable! | ||
|
|
||
| \[SC Roam Button] | ||
|
|
||
| ## [Roam Research](https://roamresearch.com/#/app/SourceCred) | ||
|
|
||
| Roam is a note-keeping platform that allows editing of the same note by different people simultaneously, and is where we archive our meeting notes. It is not necessary to join Roam or create your own account, but you will frequently see links to Roam notes dropped into the chat as a meeting gets started. | ||
|
|
||
| ##### Roam and Cred: | ||
| ##### Roam and Cred | ||
|
|
||
| SourceCred does not currently have a plugin or integration for Roam and no Cred is minted from Roam notes as of right now. Eventually we will be able to flow Cred based on factors we track, like meeting attendance, who hosted, who recorded, etc; and Cred will be distributed retroactively based on data from those past meeting notes. | ||
|
|
||
| SourceCred does not currently have a plugin or integration for Roam and no Cred is Minted from Roam notes as of right now. Eventually, we will be able to flow Cred based on factors we track like meeting attendance, who hosted, who recorded, etc; and Cred will be distributed retroactively based on data from those past meeting notes. | ||
|
|
||
| ##### Using the Shortcuts to Navigate: | ||
| ##### Using the Shortcuts to Navigate | ||
|
|
||
| *Requires a clean up of the Roam shortcuts column* | ||
| TBD *(requires a clean up of the Roam shortcuts column)* |