Comments (7)
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?
from sharing-creates-value.
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.
from sharing-creates-value.
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.
from sharing-creates-value.
from sharing-creates-value.
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,
from sharing-creates-value.
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?
from sharing-creates-value.
with the PR #90 it is now time to continue in reorganizing the repo
from sharing-creates-value.
Related Issues (20)
- Descibe the naming convention in the FAQs HOT 2
- Provide the debian copyright file acl version 2.2.52 HOT 1
- Provide the debian copyright file for jfreechart version 1.0.19 HOT 1
- FAQ: Difference from other best practice programmes? HOT 4
- Provide license analysis of the actual UBoot relaese candidate HOT 1
- Provide license analysis document of cordova android version 7.1.0 HOT 1
- correction of the cordova information required due to namin conventions HOT 1
- Provide the tooling landscape picture in a more common used format HOT 1
- Data model - company specific policy data shall be separated from the general model HOT 1
- Data model add data to cope with unknown licenses HOT 1
- Create a nice webpage for sharing-creates-value HOT 2
- Restructure the Repo to focus on the compliance tool chain HOT 1
- Tooling Landscape: Alignment with OpenChain terminology HOT 14
- Security Tooling: Is OSTG the right place for security tool and security process guidance? HOT 3
- Provide trail from user story to concrete tools HOT 2
- Add REUSE to big picture HOT 4
- Define rules for the usage of our logo HOT 1
- Menu of Existing OSS Tools too long HOT 3
- Collection of existing examples for Dependency Analyzer Source HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from sharing-creates-value.