PPMS-PublicDocs

Warning

This repository is no longer maintained as we have transitioned to a different tool for keeping our documentation. Please refer to the new documentation at developers.piwik.pro.

Choosing the right version

When working on this repository, ensure that you start from the right version. There are branches corresponding with each released PPMS major-minor version, so you can simply

git checkout X.Y

where X.Y is PPMS version of your choice, like:

git checkout 8.2

will result in checking out docs for PPMS 8.2.x.

Running docker container

To quickly view generated PublicDocs you need Docker and docker-compose (optional). Check out examples below. Feel free to adjust port numbers and volume paths to your needs.

Run with docker

Run following commands:

docker build \
    --tag "ppms-publicdocs" \
    .
docker run \
    --publish "9009:8080" \
    --volume "$(pwd):/app" \
    ppms-publicdocs

Run with docker-compose

You can run it with docker-compose up. It uses docker-compose.yaml file.

Serving generated files

Build files are served by default at http://127.0.0.1:9009/ Documentation is live (browser updates view each time any file changes).

Remote docs

If You'd like to fetch docs from a remote repository, please add requested file to the remote_docs_config.json. Each key of the json file represents a desired directory. Then You need to provide remote url and filename.

example:

  "Piwik_PRO_Library_for_Vue.md": {"url": "https://raw.githubusercontent.com/PiwikPRO/vue-piwik-pro/master/README.md", "path": "data_collection/web/frameworks/"},

To run the script You should have a projects container running (docker compose up -d). Then just run the script

docker exec -it ppms-publicdocs-ppms_public_docs-1 python3 download_remote_docs.py