Update docs content to use Hugo shortcodes
What does this MR do?
Updates markdown formatting for the new Hugo-based GitLab Docs website. See https://docs.gitlab.com/ee/development/documentation/hugo_migration#shortcodes for more information.
Omnibus docs rendered with Hugo: https://new.docs.gitlab.com/upstream-review-mr-omnibus-8174/omnibus/
Related issues
gitlab-org/technical-writing/docs-gitlab-com#44 (closed)
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course -
Follow the: -
When ready for review, MR is labeled workflowready for review per the Distribution MR workflow
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 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 above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.
Edited by Sarah German
Merge request reports
Activity
Please register or sign in to reply