docs: Lint all *.md files and replace product-edc with tractusx-edc #134
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Right now there are still some errors in the files. @stephanbcbauer how should we handle the following linting errors? |
@florianrusch-zf when i did the changes/fixes i also fixed these error manual. |
|
All linting errors are fixed: $ markdownlint-cli2-config .markdownlint.yaml "**/*.md"
markdownlint-cli2-config v0.6.0 (markdownlint v0.27.0)
Finding: **/*.md
Linting: 58 file(s)
Summary: 0 error(s) |
florianrusch-zf
commented
Mar 23, 2023
florianrusch-zf
commented
Mar 23, 2023
wolf4ood
approved these changes
Mar 23, 2023
paullatzelsperger
approved these changes
Mar 23, 2023
stephanbcbauer
requested changes
Mar 24, 2023
There was a problem hiding this comment.
Hey @florianrusch-zf as I remember you also added a link to the installation manual in the root readme.md.
Right now I can't find it. Can we add it? Or maybe with a separate PR?
|
@stephanbcbauer I haven't add this to the PR as the |
1c026a0 to
b2a0156
Compare
|
I rebased the branch on the current develop |
paullatzelsperger
pushed a commit
to paullatzelsperger/tractusx-edc
that referenced
this pull request
May 4, 2023
…/lint-markdown-files docs: Lint all *.md files and replace product-edc with tractusx-edc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To provide some documentation for the https://github.com/eclipse-tractusx/eclipse-tractusx.github.io repository we need to lint our markdown files.
This was done by using the npm package: https://www.npmjs.com/package/markdownlint-cli2
$ npm install -g markdownlint-cli2 $ markdownlint-cli2-config .markdownlint.yaml "**/*.md"The configuration file
.markdownlint.yamlwas configured like the lintting is configured in the eclipse-tractusx.github.io repository. The configuration file itself will be added to the repository with the PR #132closes #111