Contributing to the Documentation

This documentation is hosted by GitLab Pages on drupalcode.org and uses mkdocs-material. If you contribute to this documentation please refer to the documentation guidelines.

Getting started¶

If you haven't yet, clone the WissKI repository:

git clone https://git.drupalcode.org/project/wisski.git
cd wisski

You can deploy the documentation either via the development environment, or standalone The pages should automatically live-reload whenever you change files in the docs directory.

Development environment¶

You can use the development environment, as the documentation is also hosted whenever you start up the devcontainers. When the containers are running you can access the documentation at http://localhost:8000, or whatever port VSCode allocates for the documentation container.

If the pages do not reload on file-save, there might be some errors. You can check them in the container logs with

docker logs -f $(docker ps -q --filter "name=docs")

or by opening the container logs via the VSCode container section.

Standalone¶

If you want to start only the documentation container, you can do so by building the image:

docker build -t wisski-docs ./misc/docker/docs

and running it:

docker run --rm -it \
  -p 8000:8000 \
  -v ".:/docs" \
  wisski-docs \
  serve --livereload --dev-addr=0.0.0.0:8000

This also directly outputs the logs on the console.

Configuration¶

The mkdocs.yml in the wisski root directory contains all the mkdocs configuration.