8000 docs: add governance section by Jatinyadav29 · Pull Request #7675 · webpack/webpack.js.org · GitHub
[go: up one dir, main page]
Skip to content

docs: add governance section #7675

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
Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

docs: add governance section #7675

wants to merge 5 commits into from

Conversation

Jatinyadav29
Copy link

Summary

This pull request adds a "Governance" section to the documentation.
The content is adapted from the [webpack/governance](https://github.com/webpack/governance) repository’s README file and converted into MDX format to align with the webpack.js.org documentation style and structure.

Related Issue

Fixes [#7333](#7333)

Changes Introduced

  • Added new file: src/content/contribute/governance.mdx

  • Converted markdown to MDX format with frontmatter and internal link structure

  • Added YAML frontmatter:

    ---
title: Webpack Project Governance
sort: 15
contributors:
  - Jatinyadav29
---

  • Ensured compatibility with the docs build and navigation hierarchy

Preview

The new page introduces details about:

  • Roles and responsibilities (Contributors, Committers, Reviewers)
  • The Technical Steering Committee (TSC)
  • The Consensus Seeking Process

It provides transparency into webpack’s governance model, adapted from Node.js and ESLint governance frameworks.

Checklist

  • Converted README to MDX format
  • Added appropriate frontmatter and metadata
  • Verified formatting and link consistency
  • Local build runs without errors
  • Linked to the correct issue and mentioned it in the PR body

💡 Note: Since I’m still new to the webpack documentation setup, I took extra care to follow the contributing and writer’s guide. Please feel free to suggest any improvements or formatting changes.
Screenshot 2025-10-07 at 8 01 47 PM

@vercel Vercel
Copy link
vercel bot commented Oct 7, 2025

@Jatin29yadav is attempting to deploy a commit to the OpenJS Foundation Team on Vercel.

A member of the Team first needs to authorize it.

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link
linux-foundation-easycla bot commented Oct 7, 2025 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

@Jatinyadav29 Jatinyadav29 force-pushed the fix-governance-section branch from 6357918 to a6d8c6b Compare October 7, 2025 15:32
@vercel Vercel
Copy link
vercel bot commented Oct 7, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
webpack-js-org Ready Ready Preview Comment Oct 11, 2025 5:11pm

evenstensberg
evenstensberg requested changes Oct 7, 2025
View reviewed changes
Copy link
Member
@evenstensberg evenstensberg left a comment

Choose a reason for hiding this comment

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

Nice work here. Could you revert the lockfile and version bumps?

I've accepted preview of this PR so we can see the visual of the pr.

evenstensberg
evenstensberg requested changes Oct 7, 2025
View reviewed changes
Copy link
Member
@evenstensberg evenstensberg left a comment

Choose a reason for hiding this comment

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

all these also needs to be added. Add them as subsections.

Image

@Jatinyadav29
Copy link
Author
Jatinyadav29 commented Oct 8, 2025 •
edited
Loading

Hey @eventensberg
All requested changes have been addressed:

Governance section and subsections added under /src/content/contribute/governance/

Markdown lint issues (MD025, MD052) fixed

Verified locally (yarn start) — all pages render correctly

yarn.lock reverted and untouched

CLA and lint checks have passed successfully
The Vercel check is authorization-related and expected for contributors.

Ready for re-review and merge

@alexander-akait
Copy link
Member

@evenstensberg Can we write a script that fetch these files from webpack, because if we will need to change it it will require to make changes in both places, it is not good

@Jatinyadav29
Copy link
Author
Jatinyadav29 commented Oct 8, 2025 •
edited
Loading

Thanks for the feedback @alexander-akait and @evenstensberg
The idea of automating governance content sync from the webpack/governance repo makes complete sense for long-term maintainability.

For this PR, I’ve focused on adding the initial Governance section and ensuring it’s integrated properly in /src/content/contribute/governance/.

Everything now builds and renders correctly — ready for re-review whenever you’re available

@evenstensberg
Copy link
Member

Let's try to implement this correct on the first pass.

@Jatinyadav29 could you try to tackle this issue? It will make it better for you because then you can learn how the docs site really works.

@Jatinyadav29
Copy link
Author

@evenstensberg
Sure! I’d love to give it a try .
Just to confirm — you mean implementing a small script that fetches the governance content (like Charter, Member Expectations, etc.) directly from the webpack/governance repo, right?
I can explore how to integrate that with the docs build process so that it stays in sync automatically.
Please let me know if there’s a preferred approach or existing pattern I should follow.

@Jatinyadav29
Copy link
Author

Hey @alexander-akait @evenstensberg

As discussed earlier in the governance PR thread — I’ve implemented the Governance content sync automation.

This new script (src/utilities/fetch-governance.mjs) automatically fetches all markdown files from the webpack/governance repository and stores them as .mdx files inside /src/content/contribute/governance/.

Highlights

  • Uses existing utilities (githubAPI.mjs, yaml-headmatter.mjs)
  • Adds proper frontmatter (title, source, edit)
  • Converts .md → .mdx and adjusts top-level headings to pass markdownlint
  • Keeps content updated automatically (avoids manual duplication)

Verified

  • Ran node src/utilities/fetch-governance.mjs successfully
  • Verified pages render under /contribute/governance/
  • All lint checks (yarn lint-js, yarn lint-markdown) passed
  • Tested local build with yarn start

This should make the Governance section fully maintainable and synced with the official webpack/governance repo.
Happy to make any refinements if needed

evenstensberg
evenstensberg requested changes Oct 11, 2025
View reviewed changes
Copy link
Member
@evenstensberg evenstensberg left a comment

Choose a reason for hiding this comment

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

remove changes to lockfile and pkg.json, remove the md files because it is autogenerated.

@Jatinyadav29
Copy link
Author

Thanks for the feedback @evenstensberg
I’ve reverted the changes to package.json and yarn.lock, and also removed the autogenerated governance .mdx files from the PR.
Now the PR only includes the fetch-governance.mjs script, which handles fetching the governance markdown content from webpack/governance.
Please let me know if any additional adjustments are needed!

evenstensberg
evenstensberg reviewed Oct 11, 2025
View reviewed changes
package.json Outdated
"rimraf": "^6.0.1",
"sass": "^1.79.5",
"sass-loader": "^16.0.4",
"sass": "^1.93.2",
Copy link
Member

Choose a reason for hiding this comment

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

dont commit the pkg.json or yarn lock unless you've added a command to "scripts".

Copy link
Author

Choose a reason for hiding this comment

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

@evenstensberg
I tried reverting the changes in package.json and yarn.lock as suggested — I ran git checkout origin/main -- package.json yarn.lock,
but it seems the changes are still being shown in the PR.
Could you please guide me on what I might be missing or the correct way to fully revert them?
I want to make sure the PR stays clean and follows the project conventions.

Copy link
Member

Choose a reason for hiding this comment

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

Ask copilot to help you rebase and remove file changes.

Copy link
Author

Choose a reason for hiding this comment

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

ok let me try

67E6
Copy link
Author

Choose a reason for hiding this comment

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

@evenstensberg Done! I’ve rebased and pushed the clean branch — the PR now only includes the governance fetch script (fetch-governance.mjs). Thanks again for guiding me through this

@Jatinyadav29 Jatinyadav29 force-pushed the fix-governance-section branch from f0f0c8e to f1a0d6e Compare October 11, 2025 17:08
@evenstensberg
Copy link
Member

@Jatinyadav29 walk the through how to view the governance docs in your pr.

@evenstensberg
Copy link
Member

If you look here, it just renderes the main gov docs, it doesnt include the fetches files

https://webpack-js-e3xoiwwqb-openjs.vercel.app/concepts/governance/

@Jatinyadav29
Copy link
Author

Currently, the script (fetch-governance.mjs) fetches governance markdown files directly from the webpack/governance repository and saves them into /src/content/contribute/governance/.

In this PR preview, those fetched files aren’t rendered yet because the script isn’t triggered during the build process.
Once it’s added to the build or pre-deploy step (for example, running node src/utilities/fetch-governance.mjs before yarn build), the governance section will automatically sync and render those markdown files in the /contribute/governance/ path.

@evenstensberg
Copy link
Member

So this means that you are missing fetching the governance repo on every build, right? Do the same procedure as fetch-repos does, which means adding the script to our workflow. I'm happy to review this once that is done!

@Jatinyadav29
Copy link
Author

Got it @evenstensberg!
I’ll now integrate it into the existing automation (similar to fetch-package-repos.mjs), so it runs automatically on every build. Once done, I’ll update the PR for re-review.

@Jatinyadav29
Copy link
Author

@evenstensberg , I’ve now added the fetch:governance command inside the package.json scripts, so it runs automatically as part of the existing fetch workflow — just like fetch:readmes and fetch:supporters.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@evenstensberg evenstensberg Awaiting requested review from evenstensberg

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Jatinyadav29 @alexander-akait @evenstensberg
0