Skip to content

Add note on the home page title requirement for GitLab wikis

What does this MR do?

This MR makes two relatively substantial changes to the documentation about GitLab wikis:

  • it deletes the entire (small) section concerning making the home page for the wiki.
  • it modifies the section on making new wiki pages, adding a small note about how adding the first page is a slightly different looking process (perhaps we should add a picture of that default page?)
  • it adds a note to the above section that makes known that every wiki requires a home page with the title home

Related issues

Deals with the main point in #339830 (closed) as well as it's two additional suggestions

Author's checklist

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

  • ~"feature"
  • ~"frontend"
  • ~"backend"
  • ~"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 above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Amy Qualls

Merge request reports

Loading