-
Notifications
You must be signed in to change notification settings - Fork 16
docs: add Maintainer Retainer Program (MRP) section #149
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
base: main
Are you sure you want to change the base?
docs: add Maintainer Retainer Program (MRP) section #149
Conversation
- Add MRP overview with link to official OSC page - Add link preview card with og:image and Intersect-style layout - Category label: MRP; sidebar title from frontmatter
- Remove outdated link to the Maintainer Retainer page - Emphasize the importance of linking to the official OSC page for up-to-date information
Ranchhand87
left a comment
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.
Line 8: We need to add the abbreviation above in Title and/or label. Alternatively, Let's put 'Maintainer Retainer Program (MRP)' on this line.
- Clarify the title to include the full name of the program - Update descriptions for Core and Community Maintainers to better reflect roles and responsibilities - Improve links and references for governance and eligibility criteria
|
Maybe we can tag some "core" maintainers here? I was thinking it could look more paragraphical? But that could be different RE: docs in various core projects. To kick this off... |
- Revise the overview to include a direct link to the official OSC MRP page for better accessibility to detailed information on eligibility and funding.
|
Quick question: would you prefer this as a single concise paragraph, or two short paragraphs? |
Let's leave the initial format, add a one paragraph style, and a two paragraph style. We then provide optionality to participating projects to select the style that best matches their docs. Thoughts? |
|
This is a great idea. I’ll go ahead and add both options. |
- Add one-paragraph and two-paragraph style descriptions for the MRP - Clarify roles of Core and Community Maintainers with detailed responsibilities - Include links to relevant resources for better understanding of the program
|
I’ve just added the two additional options. |
I'm sorry, but what exactly you need from me / why did you tag me? |
Hi, This is currently a draft of a 'documentation update request' for the repositories/projects that are currently enrolled in the Maintainer Retainer Program. As each repo/project may have a slightly different documentation style, this is designed to serve as a reference with multiple options for how to adjust the current CONTRIBUTING.md file. Any input you may have would be helpful, A list of the enrolled projects can be found here: https://opensourcecommittee.docs.intersectmbo.org/about/paid-open-source-model-posm/maintainer-retainer/project-list |
Description
Provide a clear and concise description of the changes in this PR.
There was no dedicated documentation for the Maintainer Retainer Program (MRP) in the dev-ex repo. A reusable, draft section was needed for validation before adding it to CONTRIBUTING.md and other MRP repos.
To add a short MRP overview (Core vs Community Maintainers, official source of truth) and a link preview card for the official OSC page, so contributors have one place to reference and so the text can be reused across repos after review.
Related Issue
Fixes #148
Type of Change
Check the type of change this PR introduces:
Changes Made
What changes were made to the codebase?
Include details about files modified, functions/logic modified.
Add MRP overview with link to official OSC page
New doc
website/docs/maintainer-retainer/maintainer-retainer.md: short overview of the MRP, definitions of Core and Community Maintainers, application callouts (Community Projects + Developers → Community Maintainers), and a clear link to the official OSC Maintainer Retainer page as the source of truth.Add link preview card with og:image and Intersect-style layout
In the same doc, a link preview card for the official OSC page: blue title/URL above the card, card frame with the page’s og:image and gradient/grid styling (and dark-mode styles in
website/src/css/custom.css).Category label: MRP; sidebar title from frontmatter
New
website/docs/maintainer-retainer/_category_.ymlwith sidebar label MRP and position. Doc uses frontmattertitle: Maintainer Retainer Programso the sidebar shows that title and the page has a single clear heading.Checklist
Ensure you have completed the following steps before submitting your PR:
mainormasterbranch.