The documentation in this repository is built with Gatsby, which gives us control and flexibility over the layout.
We welcome all contributions! See LICENSE for applicable terms and conditions.
If you're authoring the documentation, just edit the Markdown files. You can use GitHub to preview the Markdown.
$variable$ are substituted with the values defined in
doc-links.yml file is the table of contents (TOC) that appears on the left sidebar.
aes-pages.yml file identifies which pages should be marked as "Ambassador Edge Stack" pages.
The docs in this repository can be "vendored" into other repositories using
Repositories that do this are encouraged to include some kind of convenience tooling to make syncing the docs easier. For example, the
following Makefile snippet:
Other repositories that include the docs as a subtree should get in the habit of doing a
git subtree pull from their
periodically. Documentation for code changes can then be committed right along-side the code changes. When a release is cut, and you are
ready to publicize it, simply do a
git subtree push.
To add a Release Notes page for a product version, you should:
- Add a
releaseNotes.ymlfile to the folder for that version of the product under
ambassador-docs/docs. A template for this file can be found here:
- Add an entry to the
doc-links.ymlfile to surface the release notes in the table of contents:
- If images need to be added, the images should be included in the