The Ligato Docs repository contains main source of documentation for Ligato. It's available at: docs.ligato.io.
Every change in the repository will be reflected on the main page after a while since there si a build process which must be completed first. The build can be watched on ReadTheDocs Ligato Builds and should only take 1-2 minutes. If the build fails for some reason, the changes will not appear on the site.
It can be a good thing to check changes locally before pushing to the main repository to ensure that everything looks like required. It may prevent broken links or any other formatting issues which may become live. To do so, you need to install
1. Install MkDocs
This site should help: install mkdocs
Please make sure to install version 1.0.4, otherwise some elements may not be formatted properly.
$ mkdocs --version mkdocs, version 1.0.4 from /usr/local/lib/python3.6/dist-packages/mkdocs (Python 3.6)
2. Clone Repository
$ git clone https://github.com/ligato/docs
3. Start Server
To start server, run following command in the root directory:
$ mkdocs serve
The documentation site should be accessible at:
http://localhost:8000/. The server also watches all changes which can be immediately seen in the browser.
Note: The mkdocs rtd-dropdown theme is used (configured inside the mkdocs.yml file). If not present, you might need to install it. Instructions here.