Skip to content

Latest commit

 

History

History
73 lines (49 loc) · 2.13 KB

README.md

File metadata and controls

73 lines (49 loc) · 2.13 KB
Raw

CloudNativePG documentation

CloudNativePG documentation is written in Markdown from the docs folder. The src folder contains the sources with the .md extension.

We have adopted MkDocs as an open source solution to build the documentation starting from Markdown format.

Before you submit a pull request for the documentation, you must have gone through the following steps:

  1. local test of the documentation
  2. run through the spell checker

How to locally test the documentation

You can locally test the documentation in two ways:

  • using Docker
  • using mkdocs directly

In both cases, you should issue the commands inside the docs folder.

With Docker, you just need to execute the following command and point your browser to http://127.0.0.1:8000/:

docker run --rm -v "$(pwd):$(pwd)" -w "$(pwd)" -p 8000:8000 \
    minidocks/mkdocs \
    mkdocs serve -a 0.0.0.0:8000

If you have installed mkdocs directly in your workstation, you can simply run:

mkdocs serve

Even in this case, point your browser to http://127.0.0.1:8000/.

Make sure you review what you have written by putting yourself in the end user's shoes. Once you are ready, proceed with the spell check and then with the pull request.

How to run the spell checker

Every time you work on the documentation, please run from the top directory:

make spellcheck

This will run a spell checker and highlight all the words that need to be either fixed or added to the .wordlist-en-custom.txt file.

How to build the documentation in HTML

From the docs folder, run the following command to build the documentation and place it in the dist directory:

docker run --rm -v "$(pwd):$(pwd)" -w "$(pwd)" \
    minidocks/mkdocs \
    mkdocs build -v -d dist

Reminders

If you added samples to docs/src/samples or modified existing samples, please consider if they should be included in the curated list of examples

And please help keeping the samples in the curated list, as well as any samples named cluster-example-* in runnable condition. These can be a big help for beginners.