Doc Issues

This page explains how documentation issues are reviewed and prioritized for the istio/istio.github.io repository. The purpose is to provide a way to organize issues and make it easier to contribute to Istio documentation. The following should be used as the standard way of prioritizing, labeling, and interacting with issues.

Prioritizing Issues

The following labels and definitions should be used to prioritize issues. If you change the priority of an issue, please comment on the issue with your reasoning for the change.

P1
  • Major content errors affecting more than 1 page
  • Broken code sample on a heavily trafficked page
  • Errors on a “getting started” page
  • Well known or highly publicized customer pain points
  • Automation issues
P2
  • Default for all new issues
  • Broken code for sample that is not heavily used
  • Minor content issues in a heavily trafficked page
  • Major content issues on a lower-trafficked page
P3
  • Typos and broken anchor links

Handling special issue types

If a single problem has one or more issues open for it, the problem should be consolidated into a single issue. You should decide which issue to keep open (or open a new issue), port over all relevant information, link related issues, and close all the other issues that describe the same problem. Only having a single issue to work on will help reduce confusion and avoid duplicating work on the same problem.

Depending on where a dead link is reported, different actions are required to resolve the issue. Dead links in the reference docs are automation issues and should be assigned a P1 until the problem can be fully understood. All other dead links are issues that need to be manually fixed and can be assigned a P3.