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

Docs/markdown broken links #49

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

cheriimoya
Copy link

This PR will

  1. fix all currently broken links,
  2. add a pipeline to the project to automatically check for broken links in any markdown files and
  3. improve the documentation on three lines.

I'd be happy to add more value to the project (especially documentation wise).

@@ -43,7 +43,7 @@ Ports:

### Dependencies

* [engine-ia-jdk8](#engine-ia-jdk8) via docker-compose network\
* [engine-ia-jdk8](#engine-ia) via docker-compose network\
Copy link
Author

Choose a reason for hiding this comment

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

I am not sure if this needs any updates with the new jdk17 container...

"ignorePatterns": [
{
"pattern": "^http(s)?://localhost(:\\d+)?",
"pattern": "^https://opensource.org/licenses/MIT$",
Copy link
Author

Choose a reason for hiding this comment

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

I don't know why, but opensource.org always throws an 503 error when running in the pipeline. Running markdown link checker locally works as expected without this exception...

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

Successfully merging this pull request may close these issues.

1 participant