Versions Compared

Old Version 40

changes.mady.by.user Benjamin Weymouth

Saved on

compared with

New Version 41

changes.mady.by.user Benjamin Weymouth

Saved on

Key

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

...

  1. Standardization improves adoption of projects within the Hyperledger Ecosystem
  2. Each project should utilize a standard Location for Documentation: we recommend ReadtheDocs
  3. A common Markup Language and interface would increase standardization 
  4. Templates exist for ReadtheDocs and can be used to improve the look and feel of any ReadtheDocs page
  5. Recognize and Resolve the impetus towards any tension between standardization (common template) with the implicit uniqueness of each Hyperledger project.
  6. 6 How to standardize contributions ( tutorials?)
    7.      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

  1. Standards should be reflected in a consistent manner such as a badging system or checkmark awarded for adherence to these principles

 

Tasks to be completed

  • Determine The Current Status of all Projects/Tools/Libraries
Status: Completed
  • Examine the current process used for documentation
Status: Completed
  • Create Standards / Best Practices for the Community
Status: In Progress
  • Create
  • Determine The Current Status of all Projects/Tools/Libraries
Status: Completed
  • Examine the current process used for documentation
Status: Completed
  • Create Standards / Best Practices for the Community
Status: In Progress
  • Create Documentation Best Practice badging system.
Status: In Progress

...

    • Besu introduces itself as a product first, whereas Fabric introduces blockchain before a product introduction. 
    • Should we standardize this? Should we introduce the product or concept? 
    • Recommendation: Plenty of space in the ReadtheDocs for conceptual resources, let’s introduce the product first. (technical documentation typically assumes the developer knows the fundamentals)
    • FAQ style Vs. Concept style. Besu uses FAQ, Fabric conceptual. 
    • Practical Vs. Theory: Besu very quickly is practical. Fabric documentation puts you through lots of theory before set-up steps. 
    • Main structure: Fabric is structured much differently from Besu. 
    • Audience: Even though the Besu documentation is deep and thorough, it is noticeably simpler in structure for a first-time user. 
    • Social Media: Besu main page is lacking social media links, and Fabric displays them- particularly the Discord is important for community engagement. 

Image Removed

...

    • Fabric is structured much differently from Besu. 
    • Audience: Even though the Besu documentation is deep and thorough, it is noticeably simpler in structure for a first-time user. 
    • Social Media: Besu main page is lacking social media links, and Fabric displays them- particularly the Discord is important for community engagement. 

Image Added

The ConsenSys guidelines are open source and anyone can contribute to them. Linking out to this guide would be helpful for our doc team to maintain the content in one location (and there would still be pages in the Besu doc wiki that are unique to Besu, e.g. the contribution workflow).
On the other hand, I understand that Besu is separate from ConsenSys and it may require a complete isolation of content, and the style/markdown guidelines may need to diverge from ConsenSys's in the future. Our team is happy to continue this discussion here and at the next community call.
Thanks,
Alexandra Tran

Comparison of Fabric Vs. SawTooth Documentation

This comparison is an initial analysis of the level of standardization between the Hyperledger Fabric Vs. SawTooth ReadTheDocs.  

...