Correctly describe GLFM features
What does this MR do?
Reviews https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md for accuracy.
Specifically, addresses inaccuracies in how describing features not present in standard Markdown: #432869 (comment 1704512565).
Also:
- Makes section
Differences between GitLab Flavored Markdown and standard Markdown
the SSoT for differences between the different Markdowns.- Deletes sentences like "This is extended from standard Markdown" from individual features' sections.
- Deletes sections
Features not found in standard Markdown
andFeatures extended from standard Markdown
and de-indents their subsections. This way, the most deeply nested heading is h4, not h5.
This MR doesn't:
- Move the sections that were previously under
Features not found in standard Markdown
andFeatures extended from standard Markdown
to keep this MR's scope to improving the page's accuracy, not style.
Related issues
- Review and update GLFM doc: features extended f... (#432869 - closed)
- #296296 (comment 1455639433)
- https://gitlab.com/gitlab-org/technical-writing/-/issues/936+
The regular good stuff
Click to expand
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added. -
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 Marcin Sedlak-Jakubowski