Skip to content
Snippets Groups Projects

Allow /help to accept either page title in front matter or in Markdown

All threads resolved!

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

  1. Set up GDK on master branch of GitLab.
  2. Check out this branch as your GitLab branch.
  3. Open GitLab in GDK and turn off /help redirection: https://docs.gitlab.com/ee/administration/settings/help_page.html#redirect-help-pages.
  4. Navigate to https://<gdk_url>/help/install/install_methods.html. The page will appear as you would expect.
  5. In the gitlab codebase, modify doc/install/install_methods.md and remove the heading # Installation methods and add title: Installation methods to the front matter.
  6. Reload https://<gdk_url>/help/install/install_methods.html and the page should look exactly the same.

Author's checklist

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 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.
Edited by Evan Read

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Ash McKenzie
  • Ash McKenzie
  • Ash McKenzie
  • Ash McKenzie
  • Sarah German approved this merge request

    approved this merge request

  • Sarah German removed review request for @sarahgerman

    removed review request for @sarahgerman

  • E2E Test Result Summary

    allure-report-publisher generated test report!

    e2e-test-on-gdk: :white_check_mark: test report for e07e9687

    expand 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   | ✅     |
    +-------------+--------+--------+---------+-------+-------+--------+
  • Evan Read added 1 commit

    added 1 commit

    • 75ce49fa - Apply 4 suggestion(s) to 2 file(s)

    Compare with previous version

  • Evan Read added 242 commits

    added 242 commits

    • 75ce49fa...3508b68b - 241 commits from branch master
    • 0a04fb54 - Allow /help to accept either page title in front matter or in Markdown

    Compare with previous version

  • Evan Read reset approvals from @sarahgerman by pushing to the branch

    reset approvals from @sarahgerman by pushing to the branch

  • Evan Read marked this merge request as ready

    marked this merge request as ready

  • Evan Read requested review from @vyaklushin

    requested review from @vyaklushin

  • Evan Read added docsfeature label and removed docsimprovement label

    added docsfeature label and removed docsimprovement label

  • Vasilii Iakliushin
  • Evan Read added 1 commit

    added 1 commit

    • a6cf3ca3 - Apply 1 suggestion(s) to 1 file(s)

    Compare with previous version

  • Evan Read added 1 commit

    added 1 commit

    • cbb034c4 - Apply 1 suggestion(s) to 1 file(s)

    Compare with previous version

  • Evan Read added 239 commits

    added 239 commits

    • cbb034c4...95073a01 - 238 commits from branch master
    • 3c3ef6ee - Allow /help to accept either page title in front matter or in Markdown

    Compare with previous version

  • Evan Read marked this merge request as draft

    marked this merge request as draft

  • Evan Read added 241 commits

    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

    Compare with previous version

  • Evan Read marked this merge request as ready

    marked this merge request as ready

  • Vasilii Iakliushin approved this merge request

    approved this merge request

  • Vasilii Iakliushin resolved all threads

    resolved all threads

  • Vasilii Iakliushin enabled an automatic merge when the pipeline for 5e171e93 succeeds

    enabled an automatic merge when the pipeline for 5e171e93 succeeds

  • mentioned in commit 168d1690

  • added workflowstaging label and removed workflowcanary label

  • Please register or sign in to reply
    Loading