fix(docs): audit and replace broken external links across docs#307
Open
Alouzious wants to merge 1 commit intoOpenSource-Communities:mainfrom
Open
fix(docs): audit and replace broken external links across docs#307Alouzious wants to merge 1 commit intoOpenSource-Communities:mainfrom
Alouzious wants to merge 1 commit intoOpenSource-Communities:mainfrom
Conversation
- Replace dead app.opensauced.pizza links - Fix opensauced.pizza/learn/#/ to /learn/ - Update broken orgs/open-sauced/discussions (404) URLs - Replace defunct opensource.fb.com/react with github.com/facebook/react - Remove trailing periods from GitHub URLs in how-to-contribute-to-open-source.md - Update open-sauced/app references to correct repos
✅ Deploy Preview for learn-open-source ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR audits several documentation pages and updates broken/outdated external links (OpenSauced domains, GitHub Discussions URLs, and legacy React docs links) to point to working alternatives.
Changes:
- Replaced dead/outdated OpenSauced and OpenSauced Docs links with GitHub-based equivalents.
- Updated community/discussions links from the old
open-saucedorg toOpenSource-Communities. - Updated legacy external references (e.g., React) to current canonical URLs.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/becoming-a-maintainer/README.md | Updates the “Community” discussions link target. |
| docs/becoming-a-maintainer/building-community.md | Replaces several OpenSauced docs links (triage guide, #100DaysOfOSS, insights). |
| docs/becoming-a-maintainer/getting-practical.md | Updates contributing/code-of-conduct/workspace/maintainer guide links referenced in examples. |
| docs/becoming-a-maintainer/how-to-setup-your-project.md | Updates the OpenSauced contributing guidelines reference link. |
| docs/becoming-a-maintainer/metrics-and-analytics.md | Updates workspace/account/insights documentation links. |
| docs/becoming-a-maintainer/your-team.md | Updates insight and onboarding-related documentation links. |
| docs/intro-to-oss/README.md | Updates the “Community” discussions link target. |
| docs/intro-to-oss/how-to-contribute-to-open-source.md | Updates community, OpenSauced app, and contributing guideline links. |
| docs/intro-to-oss/what-is-open-source.md | Updates the React reference link to a working canonical URL. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Setting Up Contributing Guidelines | ||
|
|
||
| Your project will likely have similar contribution guidelines to other projects. You can follow these steps to create guidelines and provide a template. However, if you need a specific example, you can always refer to the [OpenSauced Contributing Guidelines](https://opensauced.pizza/docs/contributing/introduction-to-contributing/). Feel free to use those guidelines and update them as you see fit for your project. | ||
| Your project will likely have similar contribution guidelines to other projects. You can follow these steps to create guidelines and provide a template. However, if you need a specific example, you can always refer to the [OpenSauced Contributing Guidelines](https://github.com/github/opensource.guide/blob/HEAD/CONTRIBUTING.md). Feel free to use those guidelines and update them as you see fit for your project. |
There was a problem hiding this comment.
The anchor text says "OpenSauced Contributing Guidelines" but the link goes to github/opensource.guide's CONTRIBUTING.md. Either update the link to the actual OpenSauced contributing guidelines, or rename the link text to reflect the Open Source Guides resource.
Suggested change
| Your project will likely have similar contribution guidelines to other projects. You can follow these steps to create guidelines and provide a template. However, if you need a specific example, you can always refer to the [OpenSauced Contributing Guidelines](https://github.com/github/opensource.guide/blob/HEAD/CONTRIBUTING.md). Feel free to use those guidelines and update them as you see fit for your project. | |
| Your project will likely have similar contribution guidelines to other projects. You can follow these steps to create guidelines and provide a template. However, if you need a specific example, you can always refer to the [Open Source Guides Contributing Guidelines](https://github.com/github/opensource.guide/blob/HEAD/CONTRIBUTING.md). Feel free to use those guidelines and update them as you see fit for your project. |
| attributes: | ||
| label: Code of Conduct | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://opensauced.pizza/docs/contributing/code-of-conduct/) | ||
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/open-sauced/docs/blob/main/docs/contributing/introduction-to-contributing.md) |
There was a problem hiding this comment.
This "Code of Conduct" link points to introduction-to-contributing.md, which doesn't match the label and is inconsistent with the later example that links to code-of-conduct.md. Update this URL to the actual Code of Conduct document.
Suggested change
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/open-sauced/docs/blob/main/docs/contributing/introduction-to-contributing.md) | |
| description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/open-sauced/docs/blob/main/docs/contributing/code-of-conduct.md) |
| 3. **Join open source communities**: There are numerous online communities, forums, and chat platforms dedicated to open source development. By joining these communities, you can connect with other developers, discover new projects, and find collaboration opportunities. In the [Community](https://github.com/orgs/OpenSource-Communities/discussions), for example, we share good first issues, cool GitHub projects, and issues we have open on our repositories. | ||
|
|
||
| 4. **Leverage OpenSauced**: [OpenSauced](https://opensauced.pizza/) is a platform that helps developers discover and contribute to open source projects. By using OpenSauced, you can find projects that align with your interests, skills, and goals. | ||
| 4. **Leverage OpenSauced**: [OpenSauced](https://github.com/open-sauced/app) is a platform that helps developers discover and contribute to open source projects. By using OpenSauced, you can find projects that align with your interests, skills, and goals. |
There was a problem hiding this comment.
The OpenSauced link now points to the GitHub repository (github.com/open-sauced/app), but the surrounding text describes a web platform users can use directly. Consider linking to the actual OpenSauced web app (signup/login) or adjust the sentence to clarify that this is the source repository.
Suggested change
| 4. **Leverage OpenSauced**: [OpenSauced](https://github.com/open-sauced/app) is a platform that helps developers discover and contribute to open source projects. By using OpenSauced, you can find projects that align with your interests, skills, and goals. | |
| 4. **Leverage OpenSauced**: [OpenSauced](https://app.opensauced.pizza) is a platform that helps developers discover and contribute to open source projects. By using OpenSauced, you can find projects that align with your interests, skills, and goals. |
Comment on lines
+52
to
53
| 1. **Sign up for an account**: Visit https://github.com/open-sauced/app and sign up for an account using your GitHub credentials. | ||
|
|
There was a problem hiding this comment.
This step instructs users to "sign up for an account" at github.com/open-sauced/app, which is a source repo and doesn't provide a signup flow. Link to the actual OpenSauced signup/login page (or update the instruction text if the intended destination is the repo).
| To create a Workspace: | ||
|
|
||
| 1. Log in to your [OpenSauced account](https://app.opensauced.pizza/). Once you're there, click the "Workspace" on the top bar, and you should see your personal workspace. | ||
| 1. Log in to your [OpenSauced account](https://github.com/open-sauced/app). Once you're there, click the "Workspace" on the top bar, and you should see your personal workspace. |
There was a problem hiding this comment.
The link for "OpenSauced account" now points to the GitHub repo, but the instruction that follows (click "Workspace" in the top bar) refers to the web app UI. Either link to the web app login page, or rewrite the step so it matches the destination.
Suggested change
| 1. Log in to your [OpenSauced account](https://github.com/open-sauced/app). Once you're there, click the "Workspace" on the top bar, and you should see your personal workspace. | |
| 1. Log in to your [OpenSauced account](https://app.opensauced.pizza). Once you're there, click the "Workspace" on the top bar, and you should see your personal workspace. |
Comment on lines
+81
to
82
| We hope you find this course informative and useful! If you have any questions or feedback, please don't hesitate to open an issue or reach out to us in the [Community](https://github.com/OpenSource-Communities/intro/discussions). | ||
|
|
There was a problem hiding this comment.
This "Community" link goes to the OpenSource-Communities/intro repository discussions, while other docs in this PR point to the organization discussions page (/orgs/OpenSource-Communities/discussions). Align on one target (and update the PR description if repo discussions are intended here).
| It is certainly possible that there's no contributor with the right skills and passion to take on a specific role. In those cases, you might need to look outside your existing community. Reach out to other projects or communities that might have individuals with the necessary expertise. | ||
|
|
||
| One way to look for potential maintainers is to create a [Repository Insight Page](https://opensauced.pizza/docs/features/repo-insights/) with projects with a similar tech stack. This will allow you to see who contributes to those projects regularly, their most used languages, and more. From there, you can narrow your search to individuals who are already familiar with your project's stack and have a proven track record of contributions by adding them to a [Contributor Insight Page](https://opensauced.pizza/docs/features/contributor-insights/). Contributor Insights allows you to see more about where they're contributing, their timezone, activity level, and more. | ||
| One way to look for potential maintainers is to create a [Repository Insight Page](https://github.com/open-sauced/docs/blob/main/docs/features/repo-insights.md) with projects with a similar tech stack. This will allow you to see who contributes to those projects regularly, their most used languages, and more. From there, you can narrow your search to individuals who are already familiar with your project's stack and have a proven track record of contributions by adding them to a [Contributor Insight Page](https://github.com/open-sauced/docs/blob/main/docs/features/repo-insights.md). Contributor Insights allows you to see more about where they're contributing, their timezone, activity level, and more. |
There was a problem hiding this comment.
The "Contributor Insight Page" link points to docs/features/repo-insights.md, which is the repository insights page, not contributor insights. Update the URL so it matches the contributor insights destination (consistent with the later link in this file).
Suggested change
| One way to look for potential maintainers is to create a [Repository Insight Page](https://github.com/open-sauced/docs/blob/main/docs/features/repo-insights.md) with projects with a similar tech stack. This will allow you to see who contributes to those projects regularly, their most used languages, and more. From there, you can narrow your search to individuals who are already familiar with your project's stack and have a proven track record of contributions by adding them to a [Contributor Insight Page](https://github.com/open-sauced/docs/blob/main/docs/features/repo-insights.md). Contributor Insights allows you to see more about where they're contributing, their timezone, activity level, and more. | |
| One way to look for potential maintainers is to create a [Repository Insight Page](https://github.com/open-sauced/docs/blob/main/docs/features/repo-insights.md) with projects with a similar tech stack. This will allow you to see who contributes to those projects regularly, their most used languages, and more. From there, you can narrow your search to individuals who are already familiar with your project's stack and have a proven track record of contributions by adding them to a [Contributor Insight Page](https://github.com/open-sauced/docs/blob/main/docs/features/contributor-insights.md). Contributor Insights allows you to see more about where they're contributing, their timezone, activity level, and more. |
| - **Timeline:** Set clear expectations for the timeline. This will help them understand what to do and the deadlines. | ||
|
|
||
| One way to onboard your new team members is to have clear guidelines and include them in your documentation. If you need an idea for creating one, you can look at the [OpenSauced Community Maintainers Guidelines](https://opensauced.pizza/docs/contributing/opensauced-maintainers-guide/community-maintainers-guide/) or read [this blog post](https://dev.to/opensauced/the-missing-piece-why-your-project-needs-a-maintainer-onboarding-process-np0). | ||
| One way to onboard your new team members is to have clear guidelines and include them in your documentation. If you need an idea for creating one, you can look at the [OpenSauced Community Maintainers Guidelines](https://github.com/open-sauced/docs/blob/main/docs/contributing/opensauced-maintainers-guide/community-maintainers-guide.md) or read [this blog post](https://github.com/open-sauced/docs/blob/main/docs/contributing/opensauced-maintainers-guide/community-maintainers-guide.md). |
There was a problem hiding this comment.
The "this blog post" link is currently identical to the OpenSauced maintainers guidelines link, so readers won't reach the intended blog post. Restore the blog post URL (previously a dev.to/opensauced/... article) or replace it with the correct blog article link.
Suggested change
| One way to onboard your new team members is to have clear guidelines and include them in your documentation. If you need an idea for creating one, you can look at the [OpenSauced Community Maintainers Guidelines](https://github.com/open-sauced/docs/blob/main/docs/contributing/opensauced-maintainers-guide/community-maintainers-guide.md) or read [this blog post](https://github.com/open-sauced/docs/blob/main/docs/contributing/opensauced-maintainers-guide/community-maintainers-guide.md). | |
| One way to onboard your new team members is to have clear guidelines and include them in your documentation. If you need an idea for creating one, you can look at the [OpenSauced Community Maintainers Guidelines](https://github.com/open-sauced/docs/blob/main/docs/contributing/opensauced-maintainers-guide/community-maintainers-guide.md) or read [this blog post](https://dev.to/opensauced/building-your-open-source-dream-team). |
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.
Fixes #268
Changes Made
opensauced.pizzalinks with working alternativesorgs/open-sauced/discussionsURLs toorgs/OpenSource-Communities/discussionsopensource.fb.com/reactwithgithub.com/facebook/reactapp.opensauced.pizzalogin links togithub.com/open-sauced/appFiles Changed
docs/becoming-a-maintainer/README.mddocs/becoming-a-maintainer/building-community.mddocs/becoming-a-maintainer/getting-practical.mddocs/becoming-a-maintainer/how-to-setup-your-project.mddocs/becoming-a-maintainer/metrics-and-analytics.mddocs/becoming-a-maintainer/your-team.mddocs/intro-to-oss/README.mddocs/intro-to-oss/how-to-contribute-to-open-source.mddocs/intro-to-oss/what-is-open-source.mdTesting