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

Add template-only markdown link linter. #264

Closed
anybodys opened this issue Dec 8, 2023 · 0 comments · Fixed by #331
Closed

Add template-only markdown link linter. #264

anybodys opened this issue Dec 8, 2023 · 0 comments · Fixed by #331
Labels
feature New feature or request good first issue Good for newcomers triage New issue which needs reviewed by a maintainer

Comments

@anybodys
Copy link

anybodys commented Dec 8, 2023 •
edited
Loading

Describe the problem and the solution you'd like

Problem

Links in markdown documentation can break as updates are made and it's difficult to track them all down to fix.

Solution

Add a linter that will check markdown files for broken links, along the lines of navapbc/template-infra#497

Since the infra template already had this linter, this template should use a "template-only" linter. That will work for this template but avoid having duplicate linters when the application template is used with the infra template.

Alternatives

Because this was already adopted in infra, we should use the same solution and not explore alternatives, unless we want to change all the templates.

Additional context

navapbc/template-application-flask#214

Priority

None
@anybodys anybodys added feature New feature or request good first issue Good for newcomers triage New issue which needs reviewed by a maintainer labels Dec 8, 2023
@anybodys anybodys mentioned this issue Dec 8, 2023
Open
@sawyerh sawyerh mentioned this issue Apr 29, 2024
Merged
sawyerh added a commit that referenced this issue Apr 29, 2024
@sawyerh
Add Markdown link checker + fix links (#331)
850a812 
## Ticket

Resolves #264

## Context for reviewers

The infra template includes a workflow that is installed along with the
template. This just adds a template-only workflow so the CI catches bad
links as they happen.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature New feature or request good first issue Good for newcomers triage New issue which needs reviewed by a maintainer
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add Markdown link checker + fix links navapbc/template-application-nextjs
1 participant
@anybodys