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

feat(config): adds validation options to ignore erroneous warnings #1715

Merged
merged 1 commit into from
Jan 2, 2024

Conversation

zakkarry
Copy link
Contributor

@zakkarry zakkarry commented Dec 31, 2023

Pull Request

Purpose

takes the responsibility of broken links off us and makes mkdocs warn on build of broken links - can see which links fail in Actions

Approach

ignore the erroneous absolute path errors so we can actually see logging events, in this case broken links

https://www.mkdocs.org/user-guide/configuration/#validation

Notes

found broken links in deluge's guide and fixed them.

  • See if actions displays broken links

Requirements

@zakkarry zakkarry self-assigned this Dec 31, 2023
@github-actions github-actions bot added Area: Backend Backend Changes, not related to a specific section Area: Downloaders Downloaders Related labels Dec 31, 2023
@zakkarry zakkarry changed the title add(config): strict set to true to fail on broken guide links feat(config): adds validation options to adjust build output Dec 31, 2023
@zakkarry zakkarry added the Area: github_actions Github Actions Related label Dec 31, 2023
@zakkarry zakkarry requested a review from TRaSH- December 31, 2023 19:13
@github-actions github-actions bot removed the Area: github_actions Github Actions Related label Jan 1, 2024
…path warnings

ignores absolute path warnings

warns on omitted or not found files

fix(guide/deluge): broken links
@zakkarry zakkarry changed the title feat(config): adds validation options to adjust build output feat(config): adds validation options to ignore erroneous warnings Jan 1, 2024
Copy link
Contributor

@bakerboy448 bakerboy448 left a comment

Choose a reason for hiding this comment

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

Seems probably fine

@bakerboy448 bakerboy448 merged commit f70008c into master Jan 2, 2024
15 checks passed
@bakerboy448 bakerboy448 deleted the broken-link branch January 2, 2024 23:42
@zakkarry zakkarry restored the broken-link branch January 3, 2024 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Backend Backend Changes, not related to a specific section Area: Downloaders Downloaders Related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants