diff --git a/README.md b/README.md index 48ff18f..a4a2e8b 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,16 @@ Sources for [Nuvolaris Community Documentation](https://nuvolaris.github.io). +## How to edit documentation + +Setup + +1. git clone git@github.com:nuvolaris/nuvolaris.github.com --recurse-submodules +2. cd nuvolaris.github.com/nuvolaris-documentat/3.1.0 +3. git checkout origin/3.1.0 -B 3.1.0 +4. cd ../.. + +Now you edit nuvolaris-documentat/3.1.0/modules + +- task preview to see in localhost:8000 +- task publish to publish documentation