XTM Hub Documentation Space

Introduction

This is the main repository of the XTM Hub Documentation space. The online version is available directly on docs.hub.filigran.io.

Install the documentation locally

Clone the repository

$ git clone [email protected]:FiligranHQ/xtm-hub-docs.git

Prepare the environment

$ python3 -m venv venv

MacOS/Linux:

$ source venv/bin/activate

Windows:

$ venv\Scripts\Activate.ps1

Install dependencies

$ pip install -r ../requirements.txt

As we are hosting the documentation on this private repository, you need to set the env vars the GitHub token to access it.

You can create a token on your GitHub account settings with these permissions:

• Commit statuses => Access: Read and write
• Contents => Access: Read and write
• Metadata => Access: Read-only
• Pages => Access: Read and write

export MKDOCS_GIT_COMMITTERS_APIKEY=[YOUR_GITHUB_TOKEN]

Launch the local environment:

$ mkdocs serve
Starting server at http://localhost:8000/

Deploy the documentation

Update the source

Commiting on the main branch does not impact the deployed documentation, please commit as many times as possible:

$ git commit -a -m "[docs] MESSAGE"
$ git push

Deploy and update the current version

With the right version number (eg. 3.3.X):

$ mike deploy --push [version]

Deploy a new stable version

With the right version number (eg. 3.3.X), update the latest tag:

$ mike deploy --push --update-aliases [version] latest

Useful commands

$ mike help
usage: mike [-h] [--version] [-q] [--debug] COMMAND ...

mike is a utility to make it easy to deploy multiple versions of your MkDocs-powered docs to a Git branch, suitable for deploying to Github via gh-pages. It's designed to produce one version of your docs at a time. That way, you can easily deploy a new version
without touching any older versions of your docs.

positional arguments:
  COMMAND
    deploy              build docs and deploy them to a branch
    delete              delete docs from a branch
    alias               alias docs on a branch
    props               get/set version properties
    retitle             change the title of a version
    list                list deployed docs on a branch
    set-default         set the default version for your docs
    serve               serve docs locally for testing