search

openpowerquality / opq

Master repository for all OPQ services
http://openpowerquality.org
18 stars 2 forks source link

Setup GitBook integration #1

Closed aghalarp closed 7 years ago

aghalarp commented 7 years ago

Please do work for this task in a branch called issue-1.

We will be using GitBook for all OPQ related documentation. Developers will be able to edit and contribute documentation by either:

  1. Using GitBook.com's online platform (a WYSIWYG editor)
  2. Installing the GitBook CLI and manually editing markdown formatted files as needed.

We should have a single 'gitbook' subdirectory under the root 'opq' directory, containing all documentation related files. Refer to GitBook configuration options on how to properly setup this directory structure.

Further investigation is needed on how to integrate JSDocs with GitBook. This seems like a good starting point.

aghalarp commented 7 years ago

A basic GitBook manual has been created in the /gitbook directory. We can edit these MD files directly or by using the GitBook online editor. The online editor has been set-up to sync with this repository - so any changes made via the editor will automatically update/commit to this repo, and any changes made via manually editing files in the gitbook directory will automatically be picked up by the online editor.

The OPQ organization GitBook page can be found here. Everyone should automatically have access once they log in with their GitHub account.

Commit 2069121e726a2f3a9f28e4d05b84fa31f3efa5ba closes #1