Page tree

Versions Compared

Key

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

...

Software-specific documentation, especially anything that potentially changes on a release-by-release basis, is maintained as .md files in the /docs directory of each project in Gerrit. The "root" of the GitBook is in https://github.com/opencord/cord/tree/master/docs (checked out by the repo tool as build/as docs). All content committed back to Gerrit will also be viewable on a public server at http://guide.opencord.org.

You can find more information in the GitBook documentation, but the general approach for contributing content is to add .md files to the appropriate docs directories checked out from Gerrit, and then view/test it locally using the GitBook toolchain.

To run the toolchain you'll need NodeJs and virtualenv installed on your machine, and then execute:

...

To build a GitBook and serve the content locally (viewable at http://localhost:40004040in a checked out repo, run

...