Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 3.09 KB

README.md

File metadata and controls

56 lines (35 loc) · 3.09 KB
Raw
orphan
true

Anbox Cloud documentation

This repository hosts the product documentation for Anbox Cloud.

Important: The concepts of the Anbox component in Anbox Cloud are similar to the Anbox open source project, but the Anbox open source project is an independent project that is not related to or used in Anbox Cloud.

Contributing to Anbox Cloud documentation

You can contribute to the Anbox Cloud documentation through either of the following channels:

  • Report a bug in Launchpad
  • Create a pull request with your changes

The Anbox Cloud team will review the issue/pull request and take the necessary action.

First-time contributors

We welcome your engagement with the Anbox Cloud community and appreciate all contributions, suggestions and feedback. There are many reasons why you should contribute to the Anbox Cloud documentation.

  • Improve your skills

    Contributing to the Anbox Cloud docs is a great way to improve your documentation and technical communication skills. You’ll get experience writing clear, concise documentation following Diátaxis principles.

  • Learn more about Anbox Cloud

    Contributing to the Anbox Cloud documentation can help you broaden your understanding of the product and its related technologies. Writing documentation often involves exploring new features and investigating potential problems or challenges users may face, which can help you learn more about how Anbox Cloud works and how users interact with it.

  • Connect with the Anbox Cloud user community

    As a user of Anbox Cloud, you’re encouraged to collaborate with other users and participate in discussions in the Discourse forum. Contributing to the documentation is a great way to connect with other users and learn from their experiences.

Style and language

Anbox Cloud documentation follows Diátaxis principles. Before starting to contribute, we encourage you to familiarise yourself with Diátaxis.

To accommodate different kinds of audience, try to:

  • Write content in a tone that’s appropriate for the subject.
  • Write inclusively and assume very little prior knowledge of the reader.
  • Link or explain phrases, acronyms and concepts that may be unfamiliar, and if unsure, err on the side of caution.

We (mostly) adhere to the Ubuntu style guide. Any deviations from the Ubuntu style guide are documented in the Anbox Cloud documentation style guide.

To help with syntax, there is a cheat sheet that lists the syntax for commonly used Markdown and MyST markup. For more detailed guidance, see the MyST style guide.

Quality checks

GitHub Actions

The following GitHub actions run automatically on every pull request:

  • Inclusive language check
  • Spellcheck
  • Accessibility check
  • Link check