fix(docs): update broken and outdated links across docs#306
fix(docs): update broken and outdated links across docs#306Alouzious 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. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Compliance Checks
Thank you for your Pull Request! We have run several checks on this pull request in order to make sure it's suitable for merging into this project. The results are listed in the following section.
Issue Reference
In order to be considered for merging, the pull request description must refer to a specific issue number.
This check is looking for a phrase similar to: "Fixes #XYZ" or "Resolves #XYZ" where XYZ is the issue number that this pull request is meant to address.
Protected Branch
In order to be considered for merging, the pull request changes must not be implemented on the "main" branch.
We would suggest that you close this pull request, create a new branch, implement your changes, and open a new pull request.
There was a problem hiding this comment.
Congratulations on submitting your first Pull Request! 🎉
We appreciate your contribution. Feel free to join the conversation in our
Community and say hello!
There was a problem hiding this comment.
Pull request overview
Updates multiple course documents to replace broken/outdated external URLs (OpenSauced domains, discussions links, and a React reference) with working destinations.
Changes:
- Replaced several
opensauced.pizza/app.opensauced.pizzalinks with GitHub-based links and updated community/discussions URLs. - Updated the React reference from
opensource.fb.comtogithub.com/facebook/react. - Refreshed OpenSauced-related references across the “intro-to-oss” and “becoming-a-maintainer” course docs.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/intro-to-oss/what-is-open-source.md | Updates React link to GitHub. |
| docs/intro-to-oss/how-to-contribute-to-open-source.md | Updates community + OpenSauced links in “finding projects” and “getting started” sections. |
| docs/intro-to-oss/README.md | Updates the Community discussions URL. |
| docs/becoming-a-maintainer/your-team.md | Replaces multiple OpenSauced docs links with GitHub-based URLs. |
| docs/becoming-a-maintainer/metrics-and-analytics.md | Replaces OpenSauced workspace/account links with GitHub-based URLs. |
| docs/becoming-a-maintainer/how-to-setup-your-project.md | Updates OpenSauced contributing-guidelines reference URL. |
| docs/becoming-a-maintainer/getting-practical.md | Updates contributing/code-of-conduct/workspace links referenced in templates and guidance. |
| docs/becoming-a-maintainer/building-community.md | Updates triage/100Days/insights links to GitHub-based URLs. |
| docs/becoming-a-maintainer/README.md | Updates the Community discussions 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 URL points to GitHub’s opensource.guide CONTRIBUTING.md. Either update the link to an OpenSauced contributing guide or change the text to match the linked resource.
| 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 [GitHub Open Source Guide 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.
In the bug report issue template example, the "Code of Conduct" checkbox links to the contributing intro doc rather than the code-of-conduct doc. This looks inconsistent with the later template in the same file; update the URL so the Code of Conduct link actually points to the code of conduct page.
| 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.
This link points to the open-sauced/app GitHub repository, but the text describes OpenSauced as a platform for discovering/contributing (implying an app/site). Consider linking to the actual OpenSauced web app/homepage, or adjust the wording so it’s clear this is the source repository.
| 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://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. |
| 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 tells readers to "sign up for an account" at a GitHub repository URL, which doesn’t support account signup. Update the URL to the actual OpenSauced signup/login page (or change the step to instructions that match the GitHub destination).
| 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 in this paragraph points to the repository insights doc (repo-insights.md) instead of the contributor insights doc. This will send readers to the wrong page; update the URL to the contributor-insights page.
| 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 was changed to a GitHub docs file and now duplicates the prior "OpenSauced Community Maintainers Guidelines" link. Either restore the intended external blog post URL or change the link text so it accurately describes the destination.
| 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) as an example. |
| 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.
This step instructs readers to log into an OpenSauced account and use the Workspace UI, but the link now points to the open-sauced/app GitHub repository (not a login page). Update the link to the actual OpenSauced app URL (or adjust the step text if you intend to link to the repo).
| 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. |
Description
Fixes broken and outdated links identified by link checker across multiple docs.
Changes Made
app.opensauced.pizzalinks inmetrics-and-analytics.mdopensauced.pizza/learn/#/→/learn/inREADME.mdand contributing docsorgs/open-sauced/discussions(404) URLsopensource.fb.com/reactwithgithub.com/facebook/reactinwhat-is-open-source.mdhow-to-contribute-to-open-source.mdopen-sauced/appreferences inbuilding-community.md,getting-practical.md,how-to-setup-your-project.md, andyour-team.mdTesting