Fixes two instances of kramdown warnings
What does this MR do?
While waiting on a links-related pipeline for an unrelated merge request (!117464 (merged)) I saw these Kramdown warnings flash by:
doc/development/sec/security_report_ingestion_overview.md
Malformed link:
kramdown warning(s) for <Nanoc::Core::CompilationItemRepView item.identifier=/ee/development/sec/security_report_ingestion_overview.md name=default>
No link definition for link ID '#scan-runs-in-a-pipeline-for-a-non-default-branch' found on line 80
doc/architecture/blueprints/secret_detection/index.md
An attempt to use the [ ]
syntax (doc/architecture
directory of using ✓
for completed items, so I switched the list over to that format.
kramdown warning(s) for <Nanoc::Core::CompilationItemRepView item.identifier=/ee/architecture/blueprints/secret_detection/index.md name=default>
No link definition for link ID 'x' found on line 166
No link definition for link ID 'x' found on line 167
No link definition for link ID ' ' found on line 168
No link definition for link ID ' ' found on line 169
No link definition for link ID ' ' found on line 170
No link definition for link ID ' ' found on line 171
No link definition for link ID ' ' found on line 172
No link definition for link ID ' ' found on line 173
No link definition for link ID ' ' found on line 174
No link definition for link ID ' ' found on line 175
No link definition for link ID ' ' found on line 176
No link definition for link ID ' ' found on line 177
No link definition for link ID ' ' found on line 178
No link definition for link ID ' ' found on line 179
No link definition for link ID ' ' found on line 180
No link definition for link ID ' ' found on line 181
No link definition for link ID ' ' found on line 182
Related issues
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.