This is the docs source for Platform Automation Toolkit, available from VMware Tanzu Network.
The production docs are here: https://docs.pivotal.io/platform-automation/
There is a public staging copy here: https://docs-pcf-staging.tas.vmware.com/platform-automation/
We use mkdocs for our documentation engine.
To use it locally, it will require python3 to be installed.
pip3 install -U -r requirements.txt
brew install ripgrep
git submodule update --init --recursive
mkdocs serve
Notes
serveing the app will check for broken external links. An error in a link might show like so:
○ → mkdocs serve
INFO - Building documentation...
INFO - Cleaning site directory
INFO - The following pages exist in the docs directory, but are not included in the "nav" configuration:
WARNING - Documentation file 'task-reference.md' contains a link to 'asdfasdf.html' which is not found in the documentation files.
Exited with 1 warnings in strict mode.
Platform Automation ci, support-pipeline, and python-mitigation-support pipelines are managed from this repo in the ci directory.
Please see the contribution doc for more information.
There is a separate Maintainers' Guide intended for personnel allocated to maintenance of the Platform Automation Toolkit.