...
Introduction/background material
Our taskforce goal was is to find gaps and opportunities in existing Hyperledger Documentation. , find conclusions and determine some recommendations. INTRO HERE-- bring in the recommendations from other section and put them here.
IDEAS:
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
Tasks to be completed
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. This is not an exhaustive review, but an initial fact finding summary. It is mean to foster open discussion and create a place for new ideas on the betterment of Hyperledger project documentation.
IDEAS:
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 |
List of deliverables or work products
...
Creation Date
2/28/22
Review Material
Fabric Documentation
...
...
Fabric
...
Documentation
Comparison of Fabric Vs.
...
Review of ReadtheDocs Syntax, Sphinx, and reStructured Syntax
Questionnaire For Hyperledger Documentation Survey
Fabric Documentation
...
Besu Documentation
Comparison of Fabric Vs. SawTooth Documentation
Comparison of Fabric Vs. Cosmos Documentation
Review of ReadtheDocs Syntax, Sphinx, and reStructured Syntax
Questionnaire For Hyperledger Documentation Survey
Fabric Documentation
Main Recommendations:
- Current / Future Hyperledger Projects should utilize the documentation pattern found on the Fabric documentation sources.
- The Fabric documentation pattern is as follows: ReadtheDocs exists as the main source of non-code truth, GitHub for all code truth, and a Hyperledger Wiki page for Community related items and badging.
- All Projects can leverage Discord: include or “pin” documentation relevant posts. (currently all are not pinned)
- Re-factor all documentation content to adhere to the various sources of truth in the Fabric documentation pattern.
- Standardize graphics across all documentation, especially in the ReadtheDocs.
- Harmonize the Read the Docs- especially in the glossary section for concept lookups and graphical standardization.
- Graphics are present in the Read the Docs page, but not present in the glossary- would be a “nice to have” to complete the glossary section.
...