Open Data Manager Documentation

This repo contains documentation site for ODM product.

Documentation site is based on Material for MkDocs.

Markdown syntax

The documentation based on Markdown Syntax. Also it supports Extended Syntax.

Also there is a lot of additional markdown features. See the reference.

If something does not work please feel free to contact with developers.

Development

Install venv

rm -rf venv
python3 -m venv venv
source venv/bin/activate

Install python dependencies

python3 -m pip install -r requirements.txt

Set credentials to Nexus

export NEXUS_USER="[email protected]"
export NEXUS_PASSWORD="your-google-password"

Set correct versions for archives of generated documentations

export OPENAPI_VERSION='1.x.x-x'  # Version from teamcity
export SDK_VERSION='1.x.xbx'  # Version from teamcity

Use script to download and unarchive generated documentations

export RAW_REGISTRY_SNAPSHOTS='https://nexus.devops.gs.team/repository/raw-snapshots'
./collect-deps.sh

To serve documentation on localhost:

mkdocs serve

Linting

We use pre-commit as a tool to maintain a unified documentation standard.

This module with these rule sets is used for linting documentation.

Install

brew install pre-commit

Run

pre-commit run -a

Deployment

Deployment latest version is configured via Github Actions.

Mike plugin is used for deploying versions.

To deploy a new version create a new branch with pattern release/*.* (for example release/1.54) and push it.

A new folder will be created in gh-pages branch that will be available on Github Pages after some time.