Page tree

Versions Compared

Key

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

...

  1. documentation manage framework, sphinx which Fabric is using. Fabric English documentation uses Sphinx v1.7 to manage documentation materials, like .rst, .md files, and the structure layout and build to final output format HTML, pdf, ePUB, etc. Sphinx is a documentation framework based on python, we need to upgrade sphinx to version 2 for more compatible. It has been done through https://gerrit.hyperledger.org/r/c/fabric/+/31667
  2. A repo to store documentation material and collaborate among contributors. Fabric English documentation uses the same repo as fabric code, it is okay for other languages to use the same existing repo, but as the documentation doesn't share the update release pace as code, it is better to use a separate repo to host ALL documentation materials.  All means do NOT separate other language documentation from English documentation, as others are translated from English. Translators/contributors need to monitor English status. 
  3. A translation tool. We prefer transfex.com. Because,
    1. it is free for open source projects. The paid account has a statistics report,  but it is fine without reports.
    2. More importantly,  it is very collaborative,  translators can working simultaneously, translating, reviewing, etc. 
    3. It provides a CLI tx, like git, contributors can use tx to pull from/push to transfex
  4. readthedocs account to host the documentation. Fabris is using it, just need to merge other languages into it.

Efforts and Resources

Suggest using a separate repo to host all documentation material. 

How To

References

For more detail refer to: 

Google Drive Live Link
urlhttps://docs.google.com/document/d/1lOF9kxjN4hK0b4YzlEVsHO8BcB2BjA3CMSemkfdDTdM/edit?usp=sharing

Efforts and Resources

Suggest using a separate repo to host all documentation material. 

How To

References


Closure

Reviewed By

  •  Arnaud Le Hors
  •  Baohua Yang
  •  Binh Nguyen
  •  Christopher Ferris
  •  Dan Middleton
  •  Hart Montgomery
  •  Kelly Olson
  •  Mark Wagner
  •  Mic Bowman
  •  Nathan George
  •  Silas Davis

...