Sharing-creates-value
Sharing-creates-value copied to clipboard
Open-Source-Compliance
Organize the repo to ease the onboarding of new members
The entire repo shall be organzised in a way that new members can be onboarded very quickly and they find easily "what is this all about", "what is there", "what is currently in work", "what is next".
I recommend to do the same as many OSS projects - create docs/getting-started as an onboarding guide for this project. I know we are now using a wiki which has a benefits that there easy editable the down side of GitHub wiki is that you can't collaborate easily on them as with commits and pull request discussions.
Should we continue using a GitHub wiki or switch to plain MarkDown files in /docs folder in the repository?
Asciidoc or reStructuredText? Markdown is somehow not mature enough for a document and everybody who can write Markdown can write Asciidoc. reStructuredText requires a solid start and a bit of learning.
In my opinion it is better to have everything in one place, for different reasons like maintainability, completeness and so on. Although I like wikis I think it is better to move the current wiki content to the repo itself.
Side note: I want to learn from this process. OpenChain’s wiki is a pain due to permissions, and we have to consolidate our material better.
On Jan 31, 2020, at 3:22, OliverFendt [email protected] wrote:
In my opinion it is better to have everything in one place, for different reasons like maintainability, completeness and so on. Although I like wikis I think it is better to move the current wiki content to the repo itself.
— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.
Wikis are where information goes to die. +1 to @OliverFendt's suggestion to keep everything in one place, and to his stated reasons. Fractured information is lost information,
Ok fine it seems that we have consensus to move the information from the wiki to the repo and shut down the wiki. What else shall we do - reorg the repo?