This repo contains the content resources for the management of the Bedrock Business Utility (BBU) Governance Framework along with the tools necessary to generate two renderings (printed, online) of the BBU-GF documents.

1. Online Governance Framework Docs
   • GitHub Pages
   • BBU GF Website - Pages Alias
2. BBU Framework Docs (PDF Version)

This repo uses GitHub Pages to host the static HTML content that is generated by MkDocs. The gh-pages branch reflects the latest committed docs. See make pages.

Use make to manage the build process for this repo.

$ make

1. Clone repository
2. Setup Environment

$ make setup

$ make dev

This repo uses mkdocs gh-deploy to push generated HTML content to GitHub. This process also creates a single PDF document in the pdf folder but the file is not pushed.

$ make pages

Note: You can ignore the DEBUG and WARNING messages during the PDF generation.

To complete the development process, follow normal git commit and git push processing. The .gitignore file will prevent the pushing of the static HTML content.

Please refer to mkdocs-pdf-export-plugin for PDF tooling configuration help.