This website is built using Docusaurus 2, a modern static website generator.
$ npm install
$ npm run start
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
$ npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
There is an continuous delivery pipeline which you can see azure-cd-pipelines.yml. This runs in Azure pipelines which deploys the website to blob storage.
Every time an item is merged into master the pipeline automatically deploys
The documentation website uses a simple blob static site with a CDN to improve content delivery. Please see the diagram to understand how content gets to our customers.
Please use the Docusaurus Creating Pages Documentation to see how best to add to the pages.
When adding Markdown documentation the Docusaurus Markdown Features provides a full description. To add references to the Markdown the sidebar needs to be updated. Docusaurus Sidebar documents how this is structured.
Docusaurus uses a header in each Markdown file to specify the metadata for that page. The Markdown Header is enclosed with a line --- above and below it.
Each Markdown document in the engineering Site should be identifiable through its file name (this is used as the file id if none is specified within the file itself).
Each Markdown document should have a title specified in its header section.
Where an alternative heading is required to be used in the sidebar, then a sidebar_label should be specified in the document header.