Skip to content

Docs: Update feature tables info for clarity

Craig Norris requested to merge docs-feature-tables-clarity into master

What does this MR do?

The Feature tables section of the Documentation Style Guide wasn't very clear, and wasn't a good resource for people who wanted to use this section for guidance. This change clearly notes the options, the code, and the displayed results.

That said, I'm opening this up to the Style Guide group for discussion. If this isn't an ideal implementation, please feel free to propose a suggestion or go ahead and change it, as needed. The idea was to provide both a graphical notation of the state and the literal words yes or no.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
    • Ensure docs metadata are present and up-to-date.
    • Ensure Technical Writing and documentation are added.
    • Add the corresponding docs:: scoped label.
    • Add twdoing when starting work on the MR.
    • Add twfinished if Technical Writing team work on the MR is complete but it remains open.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Craig Norris

Merge request reports

Loading