Skip to content

Change footnotes to specific numbering for permissions tables

Marcel Amirault requested to merge docs-permissions-footnotes into master

What does this MR do?

Following up from !79614 (merged), there was one footnote that was no longer needed for the main permissions table, and the table itself was no longer aligned. I first aligned the table columns again.

Then I realized that we could drastically improve the maintainability of the footnotes if we allow specific numbering in the list, by turning off that markdownlint rule for those footnotes. This still renders normally, but it means that maintainers will have a much easier time determining which footnote relates to which table cell when looking at the unrendered markdown.

So the full list of changes:

  • Align column cells.
  • Remove one footnote (was (*3*) formerly).
  • Renumber the footnotes lists to specific numbers.
  • Renumber all the footnote mentions to match the updated lists.

Related issues

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Marcel Amirault

Merge request reports

Loading