Skip to content

Documentation Issue Priority

David Kinder edited this page Feb 9, 2022 · 6 revisions

The ACRN project uses GitHub issues to track bugs and feature requests. Our project documentation tasks are a subset of these issues. You can add a milestone filter to further restrict what's shown, for example, all v2.8 documentation issues

We use the priority labels to identify the relative importance of these issues, as described here:

Document is related to:

  • DX team focus area
  • Mandatory for a SW release
  • Critical, reported customer support issue
  • New feature in the release

The following docs must be inspected (and updated as needed) for every release:

  • Getting Started Guide (this is the main one, not RTVM, hybrid, and partitioned Getting Started Guides)
  • What Is ACRN
  • Configuration and Development Overview
  • ACRN Configurator doc
  • Board Inspector doc
  • Future sample app documentation (e.g., RTVM+HMI scenario)
  • Release Notes
  • Supported Hardware

Document could be a customer support issue, such as a document that's obsolete or wrong but an update can be delayed given project priorities. (Delete it) It also includes what we perceive (or hear about) as gaps in documentation.

Document supports edge cases or we don’t expect customers to need it often (e.g., API/Doxygen documentation). Number of page views may be a useful tool for prioritization of such remaining docs.

Clone this wiki locally