Docs: Fix inconsistency with the style guide
What does this MR do?
Fix inconsistency with style guide.
The sample in code block we have here https://docs.gitlab.com/ee/development/documentation/structure.html#tutorials doesn't use the format for order/unordered lists we have here https://docs.gitlab.com/ee/development/documentation/styleguide/#ordered-vs-unordered-lists:
We agreed that we would keep the steps in a doc like:
1. Do this.
1. Then this.
1. Then that.
Using 1.
s is important for maintainability.
We also agreed that we would not mention "step 1, step 2, step 3..." for the same reason.
This MR fixes these inconsistencies.
Author's checklist
- [c] Follow the Documentation Guidelines and Style Guide.
-
Ensure that the product tier badge is added to doc's h1
. -
Request a review based on the documentation page's metadata and associated Technical Writer.
To avoid having this MR be added to code verification QA issues, don't add these labels: feature, frontend, backend, ~"bug", or database
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.