README.md

Teleport Docs

Teleport docs are built using mkdocs and hosted as a bunch of static files in S3.

Look at build.sh script to see how it works.

To Publish New Version

• Update build.sh.
• Update theme/base.html to add a new version to the Javascript arrray of versions
• Create a new YAML file, like 5.5.1.yaml if you are releasing version 5.5.1

Deploying

Teleport docs are published using a private web repository. See web/README.md for more info.

Running Locally

To run the latest version of the docs on http://127.0.0.1:8000:

$ ./serve.sh

To run a specific version of the docs:

$ mkdocs serve --config-file 1.3.yaml