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

Fix URL to contributors guide #51

Merged
merged 3 commits into from
Jun 18, 2024
Merged

Fix URL to contributors guide #51

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c90c45c
Fix URL to contributors guide
michael-the1 Jun 12, 2024
3af7f55
CONTRIBUTING.md -> contributing.md
michael-the1 Jun 18, 2024
a4acc7e
Merge remote-tracking branch 'picnic/master' into fix-contributors-gu…
michael-the1 Jun 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ Would you like to contribute to `dbt-score`? That's great news! Please follow

[dbt]: https://github.com/dbt-labs/dbt-core
[dbt-score]: https://dbt-score.picnic.tech/
[contributors-guide]: https://dbt-score.picnic.tech/contributors_guide
[contributors-guide]: https://dbt-score.picnic.tech/CONTRIBUTING/
Copy link
Contributor

Choose a reason for hiding this comment

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

Oh damn, can we configure mkdocs to use the former URL? Uppercase doesn't look good in an URL :/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I can't find any such configuration unfortunately

Copy link
Member

Choose a reason for hiding this comment

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

You could make a custom redirect using something like this https://github.com/mkdocs/mkdocs-redirects

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The redirect works, but at the end of the day it's still a redirect so the URL in your address bar will still be CONTRIBUTING/. The only value it would bring is that the URLs in this readme look a bit nicer, but I wouldn't install a whole plugin just for that.

Copy link
Member

Choose a reason for hiding this comment

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

Ah, I had the impression it would be an url-rewrite instead of a simple redirect. Or actually

During the mkdocs build process, this plugin will create .html files in site_dir for each of the "old" file that redirects to the "new" path

Copy link
Contributor

Choose a reason for hiding this comment

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

A simpler solution might be to rename CONTRIBUTING.md to contributing.md.

Copy link
Member

Choose a reason for hiding this comment

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

Whilst they suggest to create a file name CONTRIBUTING it does indeed look like lower-case is also supported

Contributing guidelines filenames are not case sensitive

(docs)