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.

Sign up for GitHub

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

Jump to bottom

Update markdown lint and linkchecker #521

Merged
merged 6 commits into from
Sep 24, 2020
Merged

Update markdown lint and linkchecker #521

merged 6 commits into from
Sep 24, 2020

Conversation

NicolasMassart
Copy link
Contributor

@NicolasMassart NicolasMassart commented Sep 23, 2020 •
edited
Loading

Before pushing any commit in your pull request, make sure that:

Describe the change

  • change markdown link checker dependency to use latest version as some new features are in master (I pushed a PR)
  • update link checker config
  • migrate to new linter https://github.com/DavidAnson/markdownlint
  • fix new detected MD issues
  • update CI config and package scripts
  • update helpers in CI/scripts

Issue fixed

fixes #258

Impacted parts

For content changes

  • Doc content
  • Doc pages organisation

For tools changes

  • CircleCI workflow
  • Build and QA tools (lint, vale,…)
  • MkDocs templates
  • MkDocs configuration
  • Python dependencies
  • Node dependencies and JavaScript
  • ReadTheDocs configuration
  • Github integration

Testing

https://hyperledger-besu--521.org.readthedocs.build/en/521/

@NicolasMassart
update CI and scripts
b90772a 
Signed-off-by: Nicolas MASSART <[email protected]>
@NicolasMassart
fix MD
382a5d1 
and ignore log files

Signed-off-by: Nicolas MASSART <[email protected]>
@NicolasMassart
remove previously commited logs
4c1faf4 
Signed-off-by: Nicolas MASSART <[email protected]>
@NicolasMassart
fix package path
2fd6f3a 
Signed-off-by: Nicolas MASSART <[email protected]>
@NicolasMassart
update link checker conf
0b99e21 
Signed-off-by: Nicolas MASSART <[email protected]>
@NicolasMassart NicolasMassart requested a review from a team as a code owner September 23, 2020 12:49
@NicolasMassart
restored some link exclusions
ed08a87 
probably ddos protection on etherescan
and internal postman link is in an include making path wrong
when checked separately

Signed-off-by: Nicolas MASSART <[email protected]>
@NicolasMassart NicolasMassart self-assigned this Sep 23, 2020
@NicolasMassart NicolasMassart added the DocOps Related to documentation system, tools and CI label Sep 23, 2020
@NicolasMassart NicolasMassart mentioned this pull request Sep 23, 2020
Merged
bgravenorst
bgravenorst approved these changes Sep 23, 2020
View reviewed changes
Copy link
Contributor

@bgravenorst bgravenorst left a comment

Choose a reason for hiding this comment

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

Looks good to me

@MadelineMurray MadelineMurray merged commit 82e8ca4 into hyperledger:master Sep 24, 2020
@NicolasMassart NicolasMassart deleted the 258-update-markdown-lint-and-linkchecker branch December 14, 2020 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bgravenorst bgravenorst bgravenorst approved these changes

Assignees

@NicolasMassart NicolasMassart

Labels
DocOps Related to documentation system, tools and CI
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update markdownlint and linkchecker
3 participants
@NicolasMassart @bgravenorst @MadelineMurray