Skip to content

Commit

Permalink
Fix broken links in Markdown files
Browse files Browse the repository at this point in the history
This also introduces markdown-link-check as a pre-commit hook to
check broken links in the Markdown files of the repository. The hook
has been set as manual so developers need to run it explicitly.
  • Loading branch information
replaceafill authored Sep 27, 2024
1 parent 3374c34 commit 46a1eb8
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 10 deletions.
7 changes: 7 additions & 0 deletions .markdown-link-check.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"ignorePatterns": [
{
"pattern": "^http://(127.0.0.1|localhost)"
}
]
}
10 changes: 10 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,13 @@ repos:
- types-requests
- types-python-dateutil
- pytest
- repo: https://github.com/tcort/markdown-link-check
rev: v3.12.2
hooks:
- id: markdown-link-check
stages: [manual]
args: [--quiet, --config, .markdown-link-check.json]
exclude: |
(?x)^(
src/dashboard/src/media/vendor/.*\.md
)
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -426,9 +426,9 @@ Further content comes after a blank line.
[GitHub]: https://github.com/
[guide]: https://help.github.com/articles/fork-a-repo
[excellent]: https://help.github.com/articles/using-pull-requests
[Line comment]: http://i.imgur.com/FsWppGN.png
[Line comment]: https://i.imgur.com/FsWppGN.png
[code review guidelines]: https://github.com/artefactual/archivematica/blob/qa/1.x/code_review.md
[interactive rebase feature]: http://www.git-scm.com/book/en/Git-Tools-Rewriting-History
[interactive rebase feature]: https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History
[Contributor's Agreement]: https://wiki.archivematica.org/images/e/e6/Archivematica-CLA-firstname-lastname-YYYY.pdf
[Apache Foundation]: http://apache.org
[contributor license]: http://www.apache.org/licenses/icla.txt
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,5 @@ see the [getting started] page.
[Test workflow]: https://github.com/artefactual/archivematica/actions/workflows/test.yml
[User Group]: https://groups.google.com/forum/#!forum/archivematica
[Website]: https://www.archivematica.org/
[Wiki]: https://www.archivematica.org/wiki/Development
[Wiki]: https://wiki.archivematica.org/Development
[YouTube channel]: https://www.youtube.com/@ArtefactualSystems
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ the original report, there are a couple steps you can take:

- Email the Archivematica Program Manager directly at
[[email protected]](mailto:[email protected])
- Email Artefactual's info address: [[email protected]]([email protected])
- Email Artefactual's info address: [[email protected]](mailto:[email protected])

Any information you share with the Archivematica development team as a part of
this process will be kept confidential within the team. If we determine that the
Expand Down
2 changes: 1 addition & 1 deletion hack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Artefactual developers use Docker Compose on Linux heavily so it's important
that you're familiar with it, and some choices in the configuration of this
environment break in other operative systems.

[audience-compose-reference]: https://docs.docker.com/compose/reference/overview/
[audience-compose-reference]: https://docs.docker.com/reference/cli/docker/compose/

## Requirements

Expand Down
4 changes: 1 addition & 3 deletions src/dashboard/frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -315,8 +315,6 @@ cleaner. For example, instance methods on controller objects can be easily
referenced from templates, which obviates the need to assign functions to
properties.

Here's a good guide that covers over how this works: <https://angular-tips.com/blog/2015/06/using-angular-1-dot-x-with-es6-and-webpack/>

### Modules

ES6 provides support for real modules with their own separate namespaces.
Expand Down Expand Up @@ -380,7 +378,7 @@ The contents of `app/locale` should be tracked in git.

[webpack]: https://webpack.github.io
[community Angular style-guide]: https://github.com/johnpapa/angular-styleguide#application-structure
[Jasmine]: https://jasmine.github.io/2.3/introduction.html
[Jasmine]: https://jasmine.github.io/
[Babel]: https://babeljs.io
[in the Babel documentation]: https://babeljs.io/docs/learn-es2015/
[template string]: https://babeljs.io/docs/learn-es2015/#template-strings
4 changes: 2 additions & 2 deletions src/dashboard/install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,7 @@ provides an example that implements the logging behaviour used in Archivematica
[DATABASES]: https://docs.djangoproject.com/en/1.8/ref/settings/#databases
[Sending email]: https://docs.djangoproject.com/en/1.8/topics/email/
[USER]: https://docs.gunicorn.org/en/stable/settings.html#user
[GROUP]: https://docs.gunicorn.org/en/styable/settings.html#group
[GROUP]: https://docs.gunicorn.org/en/stable/settings.html#group
[BIND]: https://docs.gunicorn.org/en/stable/settings.html#bind
[WORKERS]: https://docs.gunicorn.org/en/stable/settings.html#workers
[How Many Workers?]: https://docs.gunicorn.org/en/stable/design.html#how-many-workers
Expand All @@ -805,4 +805,4 @@ provides an example that implements the logging behaviour used in Archivematica
[ERRORLOG]: https://docs.gunicorn.org/en/stable/settings.html#errorlog
[LOGLEVEL]: https://docs.gunicorn.org/en/stable/settings.html#loglevel
[PROC-NAME]: https://docs.gunicorn.org/en/stable/settings.html#proc-name
[django-csp policy settings]: (<https://django-csp.readthedocs.io/en/latest/configuration.html#policy-settings>
[django-csp policy settings]: https://django-csp.readthedocs.io/en/latest/configuration.html#policy-settings

0 comments on commit 46a1eb8

Please sign in to comment.