Skip to content

WIP:Fix remark lint warnings in KKP docs #1954

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

archups
Copy link
Contributor

@archups archups commented Aug 13, 2025

This PR is to fix the remark-lint warnings in the KKP for main and v2.28 version documentation
This PR tries to fix as many as possible from the below reported warnings via remark-lint .

  • warning Missing code language flag fenced-code-flag
  • warning Remove 1 line before node no-consecutive-blank-lines
  • warning Misaligned table fence table-pipe-alignment
  • warning Incorrect list-item indent: remove 2 spaces list-item-indent remark-lint
  • warning Missing blank line before block node no-missing-blank-lines
  • warning Don’t use literal URLs without angle brackets no-literal-urls
  • warning Marker style should be - unordered-list-marker-style
  • warning Cell should be padded table-cell-padding
  • warning Missing final pipe in table fence table-pipes
  • warning Don’t use mixed indentation for children, add 2 spaces list-item-content-indent
  • warning Don’t add a trailing : to headings no-heading-punctuation
  • warning Rules should use --- rule-style
  • warning Incorrect list-item indent: remove 1 space list-item-indent
  • warning Do not use dollar signs before shell commands no-shell-dollars
  • warning Don’t use emphasis to introduce a section, use a heading no-emphasis-as-heading
  • warning Use spaces instead of hard-tabs no-tabs
  • warning Heading levels should increment by one level at a time heading-increment
  • warning Missing code language flag fenced-code-flag
  • warning Incorrect list-item indent: remove 2 spaces list-item-indent
  • warning Emphasis should use * as a marker emphasis-marker
  • warning Move definitions to the end of the file (after the node at line 574) final-definition
  • warning Don’t use multiple top level headings (10:1) no-multiple-toplevel-headings

@kubermatic-bot kubermatic-bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. labels Aug 13, 2025
@kubermatic-bot
Copy link
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@kubermatic-bot kubermatic-bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Aug 13, 2025
@kubermatic-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from archups. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@archups archups changed the title Fix remark lint warnings for KKP docs Fix remark lint warnings in KKP docs Aug 13, 2025
@archups archups force-pushed the fix/remark-lint-warnings branch from a7f5506 to b8e5df4 Compare August 13, 2025 21:07
@archups archups changed the title Fix remark lint warnings in KKP docs WIP: Fix remark lint warnings in KKP docs Aug 13, 2025
@archups archups marked this pull request as ready for review August 13, 2025 21:19
@archups archups changed the title WIP: Fix remark lint warnings in KKP docs Fix remark lint warnings in KKP docs Aug 14, 2025
@archups archups self-assigned this Aug 14, 2025
@kubermatic-bot kubermatic-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 14, 2025
@archups archups changed the title Fix remark lint warnings in KKP docs WIP:Fix remark lint warnings in KKP docs Aug 14, 2025
@kubermatic-bot kubermatic-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 14, 2025
@archups archups force-pushed the fix/remark-lint-warnings branch from b8e5df4 to c95f06f Compare August 14, 2025 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants