Allow /help to accept either index.md or _index.md as a docs index page
What does this MR do?
Something that we'll need for gitlab-org/technical-writing-group/gitlab-docs-hugo#62 (closed) is for /help
to work for index.md
files or _index.md
files, because Hugo requires that we eventually move from index.md
to _index.md
.
This MR updates the /help
feature:
- Main page to set an index page alternative if it sees
_index.md
. - To find a
_index.md
file even ifindex.md
orindex.html
is requested (supports older links).
Validation instructions
- Set up GDK on
master
branch of GitLab. - Check out this branch as your GitLab branch.
- Open GitLab in GDK and turn off
/help
redirection: https://docs.gitlab.com/ee/administration/settings/help_page.html#redirect-help-pages. - Navigate to:
https://<gdk_url>/help
. The content at https://docs.gitlab.com/ee/index.html should appear in a simplified form. - In the
gitlab
codebase, renamedoc/index.md
todoc/_index.md
. - Reload
https://<gdk_url>/help
and the same content should appear. - In the
gitlab
codebase, renamedoc/_index.md
todoc/test.md
. - Reload
https://<gdk_url>/help
and GitLab will error. - Navigate to
https://<gdk_url>/help/user/index.md
. The content at https://docs.gitlab.com/ee/user/index.html should appear in a simplified form. - Navigate to
https://<gdk_url>/help/user/index.html
. The content at https://docs.gitlab.com/ee/user/index.html should appear in a simplified form. - Navigate to
https://<gdk_url>/help/user/index
. The content at https://docs.gitlab.com/ee/user/index.html should appear in a simplified form. - In the
gitlab
codebase, renamedoc/user/index.md
todoc/user/_index.md
. - Navigate to
https://<gdk_url>/help/user/index.md
. The content at https://docs.gitlab.com/ee/user/index.html should appear in a simplified form. - Navigate to
https://<gdk_url>/help/user/index.html
. The content at https://docs.gitlab.com/ee/user/index.html should appear in a simplified form. - Navigate to
https://<gdk_url>/help/user/index
. The content at https://docs.gitlab.com/ee/user/index.html should appear in a simplified form. - In the
gitlab
codebase, renamedoc/user/_index.md
todoc/user/test.md
. - Reload
https://<gdk_url>/help/user/index
and GitLab will404
.
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product tier badge under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and 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.
Reviewer's 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
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. -
Ensure a release milestone is set. - 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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.
Edited by Evan Read