Skip to content
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

Fix wrapping issues in ADOPTERS #3

Merged
merged 1 commit into from
Dec 6, 2023

Conversation

hardys
Copy link
Member

@hardys hardys commented Dec 6, 2023

Looks like editor line-wrapping mangled the table formatting

@metal3-io-bot metal3-io-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 6, 2023
@hardys
Copy link
Member Author

hardys commented Dec 6, 2023

I can't see a way to escape newlines in the table markdown to satisfy MD013 so I disabled it, which seems consistent with https://github.com/metal3-io/metal3-docs/blob/main/hack/markdownlint.sh (not sure if we want to disable the others too?)

Signed-off-by: Steven Hardy <steven.hardy@suse.com>
@hardys
Copy link
Member Author

hardys commented Dec 6, 2023

/cc @kashifest

Copy link
Member

@Rozzii Rozzii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@metal3-io-bot metal3-io-bot added the lgtm Indicates that a PR is ready to be merged. label Dec 6, 2023
@metal3-io-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Rozzii

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

The pull request process is described 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

@metal3-io-bot metal3-io-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 6, 2023
@metal3-io-bot metal3-io-bot merged commit f56a113 into metal3-io:main Dec 6, 2023
3 checks passed
@tuminoid
Copy link
Member

tuminoid commented Dec 6, 2023

I can't see a way to escape newlines in the table markdown to satisfy MD013 so I disabled it, which seems consistent with https://github.com/metal3-io/metal3-docs/blob/main/hack/markdownlint.sh (not sure if we want to disable the others too?)

No, we would not like to disable that, but rather fix it. We can ignore sections like this https://github.com/metal3-io/metal3-docs/blob/dc8e8a64f06aa1ce41be38aa18e93cd095a174ed/docs/user-guide/src/version_support.md?plain=1#L78 and these days there is options in (some versions of, at least) markdownlint to disable line length for tables specifically etc.

Global ignore rules are only there because markdownlint has not been applied from the start of some repos, so the issues has not been fixed yet. Any new content and repos should not add ignore rules in markdownlint.sh.

@tuminoid
Copy link
Member

tuminoid commented Dec 7, 2023

I can't see a way to escape newlines in the table markdown to satisfy MD013 so I disabled it, which seems consistent with https://github.com/metal3-io/metal3-docs/blob/main/hack/markdownlint.sh (not sure if we want to disable the others too?)

No, we would not like to disable that, but rather fix it. We can ignore sections like this https://github.com/metal3-io/metal3-docs/blob/dc8e8a64f06aa1ce41be38aa18e93cd095a174ed/docs/user-guide/src/version_support.md?plain=1#L78 and these days there is options in (some versions of, at least) markdownlint to disable line length for tables specifically etc.

Global ignore rules are only there because markdownlint has not been applied from the start of some repos, so the issues has not been fixed yet. Any new content and repos should not add ignore rules in markdownlint.sh.

Tired to make a quick PR to address it, and it does not seem to work like it used to. I need to take a look later, if its the linter version or config issue.

@hardys hardys deleted the adopters_fix branch December 14, 2023 16:23
@hardys
Copy link
Member Author

hardys commented Dec 14, 2023

I can't see a way to escape newlines in the table markdown to satisfy MD013 so I disabled it, which seems consistent with https://github.com/metal3-io/metal3-docs/blob/main/hack/markdownlint.sh (not sure if we want to disable the others too?)

No, we would not like to disable that, but rather fix it. We can ignore sections like this https://github.com/metal3-io/metal3-docs/blob/dc8e8a64f06aa1ce41be38aa18e93cd095a174ed/docs/user-guide/src/version_support.md?plain=1#L78 and these days there is options in (some versions of, at least) markdownlint to disable line length for tables specifically etc.
Global ignore rules are only there because markdownlint has not been applied from the start of some repos, so the issues has not been fixed yet. Any new content and repos should not add ignore rules in markdownlint.sh.

Tired to make a quick PR to address it, and it does not seem to work like it used to. I need to take a look later, if its the linter version or config issue.

Yeah I did try to fix it before disabling, obviously that would be better but I couldn't see how to do it - if you figure it out please tag me on the PR so I can learn for next time :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants