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

Disable Markdown linter #126

Open
karniv00l opened this issue Jul 8, 2023 · 5 comments
Open

Disable Markdown linter #126

karniv00l opened this issue Jul 8, 2023 · 5 comments

Comments

@karniv00l
Copy link
Member

I see that some of the contributors use Github to edit content, don't have immediate feedback about enforced markdown style, or just don't care, so I would suggest disabling this workflow, and lower the entry barrier + have more green check marks in the CI

@mi-hol
Copy link
Contributor

mi-hol commented Jul 8, 2023

I'd prefer the markdown linter to stay active!
I'm not keen to see the "crap in = crap out" from RE docs again.

Instead I'd prefer to make "master" a protected branch and prohibit direct commits to it.
These direct commits to master are the root cause for markdown lint errors.

As soon as my PR #124 is merged we are back to green

@mi-hol
Copy link
Contributor

mi-hol commented Jul 8, 2023

Github to edit content,

can we configure GH to use a properly configured codespace for editing that includes md linter?

@karniv00l
Copy link
Member Author

Github to edit content,

can we configure GH to use a properly configured codespace for editing that includes md linter?

support added here: #128

Still, I think we're missing #130

@mi-hol
Copy link
Contributor

mi-hol commented Aug 26, 2023

@karniv00l with Simon's comment in discord
""In case the rule "all inputs need to be done through PR. " would have been adhered to, the situation of " fault-codes.md causes an error on every build " would not have happened. Is this a correct understanding on my side?"
You are correct and is part of the reason for the change"

the from view logical consequence would be to 'make "master" a protected branch' .
Was this proposal discussed by wiki owners?

@mi-hol
Copy link
Contributor

mi-hol commented Sep 14, 2023

validateLink.js has an dependency on markdownlint for below use case:

# Tests for linkValidator.js

## 1. test case prevented by markdownlint MD034/no-bare-urls

[T] (https://wikiXfome.tech/01-test.md) 

## 2. test case prevented by markdownlint MD034/no-bare-urls

blah (https://wiki.fome.tech/01-test.md) 

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants