docs: revamp and consolidate the Contributing section#1958
Open
Reshrahim wants to merge 6 commits into
Open
Conversation
Promote the 'Where to contribute' table to a top-level heading (it was mis-nested under GitHub), and normalize malformed 'aliases :' front matter spacing across contributing pages. Contributing and Community remain separate sections, consistent with comparable CNCF projects. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: e412b758-7998-4133-ab00-e904a086f732 Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Static Web App Preview
Deployed from commit |
Clean up and consolidate the contributing documentation: - Remove obsolete overview, community, and presentations pages - Merge maintainers-docs into contributing-docs - Restructure the advocacy page as 'Present & share Radius' - Rewrite the contributing landing page with an assertive tone - Remove the dashboard card and add the blog repository to the repositories table Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: af2ff96c-2dd1-49f8-893b-b896c1945a5c Signed-off-by: Reshma Abdul Rahim <reshmarahim.abdul@microsoft.com>
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the Contributing/Community docs content by consolidating several legacy pages into new/updated Contributing landing pages, adding aliases for legacy URLs, and modernizing the docs contribution guide content and structure.
Changes:
- Introduces a new “Present & share Radius” advocacy page and redirects legacy presentations/media-coverage URLs to it.
- Replaces the existing Contributing landing content with a new “Get started / Ways to contribute” layout and adds community-related aliases.
- Updates the docs contribution guide (including maintainer guidance) and updates the Diátaxis diagram asset; removes several old Community/Contributing pages.
Reviewed changes
Copilot reviewed 10 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/content/contributing/_index.md | Replaces Contributing landing page content; adds aliases and new “ways to contribute” structure. |
| docs/content/contributing/advocacy/index.md | Adds a new advocacy page and aliases legacy presentations/media-coverage URLs. |
| docs/content/contributing/contributing-docs/index.md | Restructures docs contributor guide; adds tabs and incorporates maintainer/upmerge guidance + new aliases. |
| docs/content/contributing/contributing-docs/diataxis.png | Updates the Diátaxis diagram image used in the docs contribution guide. |
| docs/content/contributing/overview/index.md | Removes the old Contributing overview page content. |
| docs/content/contributing/presentations/index.md | Removes the old presentations page content (now redirected via aliases). |
| docs/content/contributing/docs/_index.md | Removes the old “Docs” section index under contributing/docs. |
| docs/content/contributing/docs/maintainers-docs/index.md | Removes the old docs maintainer guide (content moved/aliased). |
| docs/content/community/_index.md | Removes the old Community section index. |
| docs/content/community/overview/index.md | Removes the old Community overview page content. |
| docs/content/community/media-coverage/index.md | Removes the old media-coverage page content. |
Comments suppressed due to low confidence (1)
docs/content/contributing/contributing-docs/index.md:574
- Grammar: “The Radius docs handles branching…” should use the plural verb form (“docs handle…”).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Reshma Abdul Rahim <61033581+Reshrahim@users.noreply.github.com>
Signed-off-by: GitHub <noreply@github.com>
Reshrahim
changed the title
Signed-off-by: GitHub <noreply@github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Revamps and consolidates the Contributing section: removes obsolete pages, flattens the folder structure, merges duplicated content, and rewrites the landing and advocacy pages for a clearer, more assertive tone. Redirects (
aliases) are added for every moved or removed page so existing URLs continue to work.Changes
Structure & deletions
community/section (_index,overview,media-coverage); relevant content now lives under Contributing.contributing/overview/— its content moved to the Contributing landing page.contributing/docs/contributing-docs/up tocontributing/contributing-docs/and removed the emptycontributing/docs/wrapper.maintainers-docsintocontributing-docs(added a "Maintaining the docs" section) and removed themaintainers-docs/page.presentations/and replaced it with a new Present & share Radius page atcontributing/advocacy/(with aliases for the old presentations and media-coverage URLs).Content updates
contributing/_index.md) with an assertive tone; removed the Dashboard card and added theradius-project/blogrepository to the repositories table.contributing-docs: fixed heading hierarchy and broken anchors, replaced leftover Dapr examples with Radius equivalents, removed the unusedcategoriesguidance (docs are organized by type), and trimmed the button-color example.No live URLs are broken — all moved/removed pages have
aliasesfor redirects.