Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

List of deliverables or work products

  • Analysis of Project Documentation Platforms
Grid analysis, showing platform currently in use

  • Report on Current Documentation processes used.

  • Create Recommendations for community

  • Create Badging process, templates
https://info.credly.com/credentialing-education-program

...

TASK FORCE NAME: Documentation Standards

Creation Date
2/28/22
Review Material


Determine The Current Status of all Projects/Tools/Libraries

  • The purpose of this section is to review the existing documentation hosting setup for multiple Hyperledger Projects.
  • Key Takeaways: 
    • Most Projects use ReadtheDocs
    • Most of those ReadtheDocs projects use either Sphinx, Restructured Text for markdown or a theme enhancer like MKdocs
    • A few projects use a non-traditional documentation hosting service, or do not use any documentation hosting service. 
    • Might be prudent to standardize / harmonize the documentation since most projects utilize ReadtheDocs
    • Fabric exists as a standard, the next section will review the fabric documentation pattern

Fabric Documentation


Hyperledger Fabric Documentation 

...