Switch from inline HTML to Markdown for code in topic
What does this MR do?
This MR solves a compatibility problem for a topic for a newer version of markdownlint-cli
than we currently use.
markdownlint-cli
0.29.0 sees id
in these examples and wants them changed to ID, per: https://gitlab.com/gitlab-org/gitlab/-/blob/a3bbe1576da77aaff83eb202e2473be97ba3fdbd/.markdownlint.yml#L72. Because it's the code samples aren't wrapped in ```
, they are treated like plain text in the newer version.
Switching also has the advantage of allowing us to syntax highlight. For example
- Before: https://docs.gitlab.com/ee/development/database/efficient_in_operator_queries.html#performance-problems-with-in-queries
- After: http://main-ee-72468.178.62.207.141.nip.io/ee/development/database/efficient_in_operator_queries.html#performance-problems-with-in-queries
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course -
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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.