Versions Compared

Key

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

...

  • Standardize documentation content to promote increased usage and project adoption 
  • Re-factor any existing inconsistencies in style, graphics, tables, bullet points, readability, links, and content usefulness for all projects to better serve future and current Hyperledger projects. 
  • Current / Future Hyperledger Projects should both utilize the a standardized and agreed upon documentation pattern
  • The Fabric documentation pattern could serve as a template: 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. 
  • Standardize graphics across all documentation, especially in the ReadtheDocsHarmonize the Read the Docs- especially in the and the glossary section for better concept lookups and graphical standardizationuser experience
  • All Projects can leverage Discord: include or “pin” documentation relevant posts. (currently all are not pinned) 

...

  • The purpose of this section is to review the existing documentation hosting setup for multiple Hyperledger Projects.
  • Key Takeaways: 
    • Most Projects use ReadtheDocs (detailed grid analysis found here)
    • 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

Key Takeaways: 

  • Fabric uses Read the Docs as the main source of truth for descriptions, GitHub as the source of truth for Code, and the HyperLedger Wiki page as the source of Truth for community related items. 
  • Projects should be customized as required. But some information in Fabric is spread out over multiple pages.  Thus, it would be more efficient to be grouped by audience for easier readability.
  • For example, some details are on the wiki page that aren’t on Read the Docs- and vice versa.
  • Use of graphics on the Read the Docs is sometimes inconsistent.

Hyperledger Fabric Documentation 

...

  1. HyperLedger Fabric Read the Docs: https://hyperledger-fabric.readthedocs.io/
    • Designed for Multiple Audiences: Developers and Business Professionals
    • Generally follows topical organization with bullet points 
    • Has code, helpful imagery, written explanations 
    • Sorts concepts into tutorials, very comprehensive spread of information 
    • Doesn’t include source code files, at times will link to GitHub files for more detail
    • Some areas are informative, rich knowledge base
    • Use Cases area could be more informative (Recommend re-fresh / re-formatting of both pages, especially wiki page. currently just links to hyperledger wiki) 
  2. HyperLedger Fabric Main GitHub page: https://github.com/hyperledger/fabric
    • Designed for developers: whether smart contract, application or enterprise blockchain developers 
    • Has a Readme file for general information, versioning, installation 
    • Links back to the HyperLedger Fabric Wiki 
  3. HyperLedger Fabric Wiki: https://wiki.hyperledger.org/display/fabric
  4. HyperLedger Fabric Discord Documentation Channel: https://discord.com/channels/905194001349627914/945038395825070141
    • The Discord channel is designed for asking and answering questions, fostering discussion regarding HyperLedger Fabric Documentation 
    • Not a single source of truth for any audience, however helpful for business, developer or community members 
    • Lots of useful links, but nothing is pinned for quick access
    • As Discord becomes bigger, “pinning” will be eminently helpful 
  5. HyperLedger Fabric LandScape Page: https://landscape.hyperledger.org/projects?selected=hyperledger-fabric 
    • The LandScape Page holds notable metrics, badging, links and an aggregate of the Fabric Twitter Page
    • Metrics include the programming languages used, and the number of recent commits.
    • The links include a comprehensive list of the various Fabric GitHub repositories 
    • The Twitter aggregate section includes the latest 3 tweets from the Hyperledger Foundation

Some Key Conclusions:

...


Comparison of Fabric Vs. Besu Documentation

...