...
Our taskforce goal is to find gaps and opportunities in existing Hyperledger Documentation. Herein, find we present conclusions and determine some recommendations. INTRO HERE-- bring in the recommendations from other section and put them here. This Review focuses on a variety of documentation for the Hyperledger Fabric project, as a case study indicative of how other pages might be standardized.
This document is representative of a fact finding mission with generalized conclusions. These conclusions should be discussed, edited and converted into direct action items. Our taskforce is mean to foster open discussion and create a place for new ideas on the betterment of Hyperledger project documentation.
GUIDING PRINCIPLES:
1. Utilize a standarLocation of Documentation: we recommend ReadtheDocs
2. Markup Language
3. Template
4. licensing
5. Weighing standardization (common template) with project uniqueness.
6 How to standardize contributions ( tutorials?)
...
Scorecard: make sure each project is advancing and
...
implemented guidelines across projects: example of scorecard https://github.com/ossf/scorecard
Badging: one time badging with yearly review
Tasks to be completed
| Status: Completed |
---|---|
| Status: Completed |
| Status: In Progress |
| Status: In Progress |
...