Documentation Issue Priority

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:

priority: high docs

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 Introduction
• Configuration and Development Overview
• Intro to ACRN Configuration
• ACRN Configurator Tool
• Board Inspector Tool
• Future sample app documentation (e.g., RTVM+HMI scenario)
• Release Notes
• Security Advisory
• Supported Hardware

priority: medium docs

Document could be a customer support issue, such as a document that's obsolete or wrong but the estimated impact is not high and an update can be delayed given project priorities. We could also delete it if no update is appropriate. These issues includes what we perceive or hear about as gaps in documentation that don't require a priority: high fix.

priority: low docs

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 prioritizing such docs.