add Hugo documentation #195
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
IMPORTANT
The docs directory now contains the published version of the Hugo website.
The hugo directory now contains the developer's version of the Hugo website.
When editing documentation, navigate to $COROOT/hugo/content and modify the documents accordingly.
$COROOT/hugo/content/_index.adocis the equivalent ofREADME.adoc. All other documents are edited in a logical fashion.If when writing new documentation, you want to use shortcodes (for example, what's shown on the Upgrading the Operator page - the drop downs), visit this link: http://docdock.netlify.com/shortcodes/
When ready to publish changes to documentation, the workflow is as follows:
That simple! When the hugo command is run, it publishes the generated version of the website in the
$COROOT/docsdirectory.The site should be accessible from crunchydata.github.io/postgres-operator after you navigate to https://github.com/crunchydata/postgres-operator/settings and select "Source -> master branch /docs folder".
For a working demo of the website, visit https://xenophenes.github.io/pgo-docs/