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

docs: add automatic listing of governance archives #13185

Merged

Conversation

EricFromCanada
Copy link
Member

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run 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.

@BrewTestBot
Copy link
Member

Review period will end on 2022-04-26 at 00:00:00 UTC.

@BrewTestBot BrewTestBot added the waiting for feedback Merging is blocked until sufficient time has passed for review label Apr 23, 2022
docs/Governance-Archives.md Outdated Show resolved Hide resolved
docs/Governance-Archives.md Outdated Show resolved Hide resolved
@EricFromCanada EricFromCanada force-pushed the governance-archives-listing branch 2 times, most recently from ccb90b9 to 35a1dd3 Compare April 25, 2022 13:07
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a 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)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- [Homebrew Governance Archives](Governance-Archives.md)
- [Homebrew Governance Archives](Homebrew-Governance-Archives.md)

for pedantic consistency? I'm sorry 😂

Copy link
Member Author

Choose a reason for hiding this comment

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

🤷‍♂️

@BrewTestBot BrewTestBot removed the waiting for feedback Merging is blocked until sufficient time has passed for review label Apr 26, 2022
@BrewTestBot
Copy link
Member

Review period ended.

ARREOLACAR referenced this pull request Apr 26, 2022
- Without this, vale won't correctly detect where the styles are.
@MikeMcQuaid MikeMcQuaid merged commit bb3d970 into Homebrew:master May 2, 2022
@MikeMcQuaid
Copy link
Member

Thanks again @EricFromCanada!

@EricFromCanada EricFromCanada deleted the governance-archives-listing branch May 2, 2022 11:27
@github-actions github-actions bot added the outdated PR was locked due to age label Jun 2, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants