This repo contains documentation for Akri, including:
To add documentation to Akri's GitBook documentation site, create a markdown file in the appropriate section folder
within docs
.
Akri's documentation is divided into six sections:
Then, link to it in SUMMARY.md
to ensure it is displayed on Akri's site.
Add associated images to the media
folder and adhere to GitBook Markdown syntax
requirements.
To propose a design for a new Akri feature such as a new Discovery Handler, create a PR to add your document to the proposals folder. A proposal template and conventions for updating proposal statuses will be added soon.
If you have guides, scenarios, examples, etc. that you think would benefit from being a part of the Akri ecosystem but do not fit on Akri's documentation site or as a proposal, they could be added to Akri's HackMD. Create an issue to request that a HackMD page be created for the content.
If you have a scenario or use-case you'd like to share more broadly, we are always looking for contributions to Akri's Medium Blog.
The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page