Skip to content

Resolve various Kramdown warnings

Amy Qualls requested to merge aqualls-fix-kramdown-2024 into master

What does this MR do?

Here are some cleanups of a few Kramdown warnings I saw when building the site locally today:

kramdown warning(s) for <Nanoc::Core::CompilationItemRepView item.identifier=/ee/api/merge_requests.md name=default>
  Found block HTML tag 'ul' in span-level text on line 2020
  Found block HTML tag 'li' in span-level text on line 2020
  Found invalidly used HTML closing tag for 'li' on line 2020
  Found block HTML tag 'li' in span-level text on line 2020
  Found invalidly used HTML closing tag for 'li' on line 2020
  Found block HTML tag 'li' in span-level text on line 2020
  Found invalidly used HTML closing tag for 'li' on line 2020
  Found invalidly used HTML closing tag for 'ul' on line 2020
  Found block HTML tag 'ul' in span-level text on line 1
  Found block HTML tag 'li' in span-level text on line 1
  Found invalidly used HTML closing tag for 'li' on line 1
  Found block HTML tag 'li' in span-level text on line 1
  Found invalidly used HTML closing tag for 'li' on line 1
  Found block HTML tag 'li' in span-level text on line 1
  Found invalidly used HTML closing tag for 'li' on line 1
  Found invalidly used HTML closing tag for 'ul' on line 1

kramdown warning(s) for <Nanoc::Core::CompilationItemRepView item.identifier=/ee/development/feature_flags/index.md name=default>
  No link definition for link ID 'deprecated' found on line 244

kramdown warning(s) for <Nanoc::Core::CompilationItemRepView item.identifier=/ee/solutions/cloud/aws/gitlab_aws_integration.md name=default>
  No link definition for link ID '[12/28/2023](https://aws.amazon.com/about-aws/whats-new/2023/12/codepipeline-gitlab-self-managed/)' found on line 36
  No link definition for link ID '[12/28/2023](https://aws.amazon.com/about-aws/whats-new/2023/12/codepipeline-gitlab-self-managed/)' found on line 43
  No link definition for link ID '[12/28/2023](https://aws.amazon.com/about-aws/whats-new/2023/12/codepipeline-gitlab-self-managed/)' found on line 44
  No link definition for link ID '[12/28/2023](https://aws.amazon.com/about-aws/whats-new/2023/12/codepipeline-gitlab-self-managed/)' found on line 45
  No link definition for link ID '[12/28/2023](https://aws.amazon.com/about-aws/whats-new/2023/12/codepipeline-gitlab-self-managed/)' found on line 54
  No link definition for link ID '[12/28/2023](https://aws.amazon.com/about-aws/whats-new/2023/12/codepipeline-gitlab-self-managed/)' found on line 58
  No link definition for link ID '[12/28/2023](https://aws.amazon.com/about-aws/whats-new/2023/12/codepipeline-gitlab-self-managed/)' found on line 59
  No link definition for link ID '[12/28/2023](https://aws.amazon.com/about-aws/whats-new/2023/12/codepipeline-gitlab-self-managed/)' found on line 74
  No link definition for link ID '06/06/2020' found on line 79
  No link definition for link ID '[06/13/2022](https://aws.amazon.com/about-aws/whats-new/2023/06/amazon-codeguru-security-available-preview/)' found on line 87
  No link definition for link ID '[12/28/2023](https://aws.amazon.com/about-aws/whats-new/2023/12/codepipeline-gitlab-self-managed/)' found on line 91
  No link definition for link ID '7/31/2021' found on line 92

Related issues

Author's checklist

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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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.

Merge request reports