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: add automatic listing of governance archives #13185
docs: add automatic listing of governance archives #13185
Conversation
Review period will end on 2022-04-26 at 00:00:00 UTC. |
ccb90b9
to
35a1dd3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fine with or without optional change, nice work here as usual @EricFromCanada!
docs/README.md
Outdated
@@ -74,3 +74,4 @@ | |||
|
|||
- [Homebrew Governance](Homebrew-Governance.md) | |||
- [Homebrew Leadership Responsibilities](Homebrew-Leadership-Responsibilities.md) | |||
- [Homebrew Governance Archives](Governance-Archives.md) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- [Homebrew Governance Archives](Governance-Archives.md) | |
- [Homebrew Governance Archives](Homebrew-Governance-Archives.md) |
for pedantic consistency? I'm sorry 😂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤷♂️
Review period ended. |
- Without this, vale won't correctly detect where the styles are.
35a1dd3
to
b22b413
Compare
Thanks again @EricFromCanada! |
brew style
with your changes locally?brew typecheck
with your changes locally?brew tests
with your changes locally?With this, any .md files added to the "governance" folder will be linked from /Governance-Archives.
I'd originally planned to implement the listing as a Jekyll collection, but doing so would have required each file to have empty front matter because the
jekyll-optional-front-matter
plugin currently does not apply to collections. What this does instead is automatically add a category to each page in the folder and iterate through each categorized page.