cortopy / openobserve-docs

OpenObserve documentation

OpenObserve documentation

Documentation is built using Material for MkDocs.

dev containers

Best way to start with updating documentation is to open this repo using vs code dev containers

You will need to fix/delete/comment mounts section in .devcontainer/devcontainer.json before you open the repo in dev container.

Once you have opened the source code in dev container, run the following command to start documentation server:

mkdocs serve

Expose port 8000

Now you will be able to open the docs on http://localhost:8000

To generate docs without vscode run below command

docker run --rm -it -v $PWD:/site squidfunk/mkdocs-material build

virtual environment

You can use python virtual environment to do development as well

source setup_env.sh
mkdocs serve