[docs-only] Add a note in dev docs/build the docs

This commit is contained in:
mmattel
2024-08-21 12:29:31 +02:00
parent d4db23c481
commit fe692b420b
2 changed files with 22 additions and 19 deletions
+2
View File
@@ -17,6 +17,8 @@ For building the documentation you need to have Make and Go 1.14 or higher insta
Just run `make -C docs docs-serve` from within the root level of the oCIS git repository. This will make documentation available on [localhost:1313](http://localhost:1313) and also do a hot reload if you change something in the (non autogenerated) documentation files.
Note that you may get files changed reported like `env_vars.yaml` by just running the make command. You can discard any of these as they come from an internal helper process step necessary. To take care on those changed files, see the [Docs Helpers](https://github.com/owncloud/ocis/tree/master/docs/helpers) readme.
## Add changes to the documentation
Please keep this documentation in sync with the oCIS source code.