Documentation for Amphitheatre

This website is built with Zola. Content includes all Amphitheatre usage guides, desktop and terminal command line manuals, as well as API interface definitions and other documentation, written using CommonMark, a well-defined and highly compatible Markdown specification. Pull requests welcome!

Developing

$ zola serve # dev server at http://127.0.0.1:1111

This will build and serve the site using a local server. Before starting, Zola will delete the output directory (by default public in project root) to start from a clean slate.

The serve command will watch all your content and provide live reload without a hard refresh if possible. If you are using WSL2 on Windows, make sure to store the website on the WSL file system.

Some changes cannot be handled automatically and thus live reload may not always work. If you fail to see your change or get an error, try restarting zola serve.

Deploying

The site is automatically deployed when commits land in master, via Netlify.

If you are the maintainer of a community translation fork and would like to deploy via Netlify instead of GitHub pages, please ping @wangeguo in an issue to request a Netlify team membership and DNS update.

Want to help with the translation?

If you feel okay with translating quite alone, you can fork the repo, post a comment on the Community Translation Announcements issue page to inform others that you're doing the translation and go for it.

Credits

Heavily inspired by

• https://github.com/GoogleContainerTools/skaffold/tree/main/docs
• https://docs.k8slens.dev/main/
• https://doc.rust-lang.org/cargo/index.html
• https://cli.github.com/manual/
• https://www.okteto.com/docs/