diff --git a/docs/mkdocs-howto.md b/docs/mkdocs-howto.md new file mode 100644 index 00000000..dac12c1e --- /dev/null +++ b/docs/mkdocs-howto.md @@ -0,0 +1,20 @@ +# Working on docs locally + +To work on documentation locally and preview it while developing, we can use `mkdocs serve` + +Start by installing the requirements for documentation. + +``` shell +pip install -r doc-requirements.txt +``` + +!!! tip + + You may want to first create a virtualenv and install requirements in there. + +Once the installation is done, run the mkdocs server locally to view your changes. + +``` shell +cd genestack/ +mkdocs serve +``` diff --git a/mkdocs.yml b/mkdocs.yml index 9df0bdb8..f54935a8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -192,6 +192,7 @@ nav: - Creating Networks: openstack-neutron-networks.md - Glance Images Creation: openstack-glance-images.md - Building Local Images: build-local-images.md + - Working Locallly With Docs: mkdocs-howto.md - Third Party Tools: - OSIE: extra-osie.md - Cloud Onboarding: