Allow /help to accept either page title in front matter or in Markdown
What does this MR do?
To help answer one of the questions at: gitlab-org/technical-writing-group/gitlab-docs-hugo#56, allow /help
to properly render Markdown pages that have the title in front matter instead of in main Markdown content.
This allows /help
to render Markdown files destined for a Hugo site, per: https://gohugo.io/content-management/front-matter/.
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/install/install_methods.html
. The page will appear as you would expect. - In the
gitlab
codebase, modifydoc/install/install_methods.md
and remove the heading# Installation methods
and addtitle: Installation methods
to the front matter. - Reload
https://<gdk_url>/help/install/install_methods.html
and the page should look exactly the same.
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.
Merge request reports
Activity
changed milestone to %16.10
assigned to @eread
- A deleted user
added backend label
1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
-
doc/development/documentation/help.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
Reviewer roulette
Category Reviewer Maintainer backend @radbatnag
(UTC+8, 2 hours behind author)
@nbelokolodov
(UTC+13, 3 hours ahead of author)
Please check reviewer's status!
Please refer to documentation page for guidance on how you can benefit from the Reviewer Roulette, or use the GitLab Review Workload Dashboard to find other available reviewers.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger-
removed backend label
added 1 commit
- a254e57e - Allow /help to accept either page title in front matter or in Markdown
- A deleted user
added backend label
- Resolved by Vasilii Iakliushin
@ashmckenzie Could you review from a Ruby code-quality perspective?
@sarahgerman Could you review from a we need this for gitlab-org/technical-writing-group/gitlab-docs-hugo#56 perspective?
Edited by Evan Read
requested review from @ashmckenzie and @sarahgerman
mentioned in issue gitlab-org/technical-writing-group/gitlab-docs-hugo#56
- Resolved by Evan Read
- Resolved by Evan Read
- Resolved by Evan Read
- Resolved by Evan Read
- Resolved by Evan Read
- Resolved by Evan Read
@sarahgerman
, thanks for approving this merge request.This is the first time the merge request has been approved. To ensure we don't only run predictive pipelines, and we don't break
master
, a new pipeline will be started shortly.Please wait for the pipeline to start before resolving this discussion and set auto-merge for the new pipeline. See merging a merge request for more details.
added pipeline:mr-approved label
removed review request for @sarahgerman
E2E Test Result Summary
allure-report-publisher
generated test report!e2e-test-on-gdk:
test report for e07e9687expand test summary
+------------------------------------------------------------------+ | suites summary | +-------------+--------+--------+---------+-------+-------+--------+ | | passed | failed | skipped | flaky | total | result | +-------------+--------+--------+---------+-------+-------+--------+ | Create | 66 | 0 | 9 | 0 | 75 | ✅ | | Govern | 66 | 0 | 0 | 1 | 66 | ✅ | | Plan | 53 | 0 | 0 | 0 | 53 | ✅ | | Verify | 35 | 0 | 1 | 0 | 36 | ✅ | | Data Stores | 31 | 0 | 0 | 0 | 31 | ✅ | | Package | 24 | 0 | 2 | 0 | 26 | ✅ | | Analytics | 2 | 0 | 0 | 0 | 2 | ✅ | | Monitor | 7 | 0 | 0 | 0 | 7 | ✅ | | Release | 5 | 0 | 0 | 0 | 5 | ✅ | | Manage | 0 | 0 | 1 | 0 | 1 | ➖ | +-------------+--------+--------+---------+-------+-------+--------+ | Total | 289 | 0 | 13 | 1 | 302 | ✅ | +-------------+--------+--------+---------+-------+-------+--------+
added 242 commits
-
75ce49fa...3508b68b - 241 commits from branch
master
- 0a04fb54 - Allow /help to accept either page title in front matter or in Markdown
-
75ce49fa...3508b68b - 241 commits from branch
reset approvals from @sarahgerman by pushing to the branch
requested review from @vyaklushin
added docsfeature label and removed docsimprovement label
- Resolved by Evan Read
- Resolved by Evan Read
- Resolved by Vasilii Iakliushin
added 239 commits
-
cbb034c4...95073a01 - 238 commits from branch
master
- 3c3ef6ee - Allow /help to accept either page title in front matter or in Markdown
-
cbb034c4...95073a01 - 238 commits from branch
added 241 commits
-
3c3ef6ee...03889419 - 239 commits from branch
master
- 589ccf65 - Allow /help to accept either page title in front matter or in Markdown
- e07e9687 - Rename some test to avoid clashing group names
-
3c3ef6ee...03889419 - 239 commits from branch
enabled an automatic merge when the pipeline for 5e171e93 succeeds
mentioned in commit 168d1690
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
added releasedcandidate label
added workflowpost-deploy-db-staging label and removed workflowproduction label
added workflowpost-deploy-db-production label and removed workflowpost-deploy-db-staging label
mentioned in merge request kubitus-project/kubitus-installer!2869 (merged)
added releasedpublished label and removed releasedcandidate label
added pipelinetier-3 label