Skip to content

Clarify linking Wiki pages in asciidoc format

Caleb Williamson requested to merge calebw-master-patch-38960 into master

What does this MR do?

Adds a note to the Includes section of the documentation that mentions which file format should be used for linking AsciiDoc formatted Wiki pages.

When a new Wiki page is created and the AsciiDoc format is used, these files are saved with the extension .asciidoc on the backend. If you're attempting to add an include to your Wiki page that references another Wiki page in this format, using .adoc will not work.

Related issues

N/A

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.

Merge request reports