/sdp-docs

Documentation for DPC SDP projects

Primary LanguageDockerfile

Documentation for SDP

CircleCI

https://dpc-sdp.github.io/sdp-docs/

Requirements

Quickstart

To build and serve locally: ahoy build

Available commands

   build        Build site
   deploy       Deploy site
   version      MkDocs version

Automated deployment

CircleCI is configured to perform automated deployments for the main branch. The built site is automatically pushed to gh-pages branch.

Also note that built site is available in CircleCI build artifacts tab.

Important! Do not commit to gh-pages branch manually. Also, try to avoid using ahoy deploy command manually (it is used by CI).

Maintenance

SDP development team is a main maintainer of this documentation.

We welcome contributions to this documentation! Please open an issue or submit a pull request.