This repository contains the markdown contents of the documentation site at https://unikraft.com/docs.
Contributions to the documentation are welcome! If you're looking to file an issue or bug report for anything other than these documentations, please visit the roadmap.
The pages/ directory contains all the markdown files for Unikraft Cloud's documentation.
To maintain consistency and accuracy across all documentation pages, vale lints all written prose.
To make the contribution process as seamless as possible, please follow these requirements:
- Fork the project and make your changes.
- When you’re ready to create a pull request, be sure to:
- Run
make lintto check all documentation. - Squash your commits into to logical, atomic commits (
git rebase -i). It's okay to force update your pull request withgit push -f. - Follow the Git Commit Message Guidelines below.
- Run
- All commits must be signed off (
git commit -s) by all authors in order to certify that the contributions are published under the Developer Certificate of Origin (DCO).
This project follows a modified version of the AngularJS Commit Guidelines. A commit message should take the following form:
<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
where <body> and <footer> containing at least the contributions DCO.
The <type> should be one of the following:
chore: Maintenance tasks for the repository itself.ci: Changes related to GitHub actions or any other CI/CD-related operations.docs: Documentation only changes (for example, this README, or source comments).feat: A new feature.fix: A bug fix.perf: A code change that improves performance (in this case, please include relevant benchmarks).refactor: A code change that neither fixes a bug nor adds a feature.style: Changes that don't affect the meaning of the code (for example, code formatting).test: Adding new tests, missing tests, or correcting existing tests.
An example would be something like:
feat(guides): Add foobar deployment example
This commit adds a new example deployment to Unikraft Cloud
which demonstrates how to use foobar.
GitHub-Fixes: #30
Signed-off-by: Bobo Monkey <monkey@unikraft.com>
Copyright Unikraft GmbH © 2025.
All rights reserved.
Unikraft GmbH licenses this documentation under BSD-3-Clause, see LICENSE.md for more details.