Skip to content

Commit

Permalink
fix: broken links caused by new url for docs (#341)
Browse files Browse the repository at this point in the history
* Replace old docs links with new

* Replace intro links with learn links

* Fix links in nav bar

* Fix footer link to blog

* Change the url back after overwriting with find and replace
  • Loading branch information
BekahHW authored Jun 21, 2024
1 parent 280f3ec commit 64ba379
Show file tree
Hide file tree
Showing 33 changed files with 40 additions and 47 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

## 🤝 Contributing

We encourage you to contribute to OpenSauced! All contributors are required to abide by our [Code of Conduct](https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md). Please check out the [Contributing guide](https://docs.opensauced.pizza/contributing/introduction-to-contributing/) for guidelines about how to proceed with your contribution.
We encourage you to contribute to OpenSauced! All contributors are required to abide by our [Code of Conduct](https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md). Please check out the [Contributing guide](https://opensauced.pizza/docs/contributing/introduction-to-contributing/) for guidelines about how to proceed with your contribution.

<img align="right" src="https://i.ibb.co/CJfW18H/ship.gif" width="200"/>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Maintainers want to help you write your PR; that’s why they often outline cont

![Jerry McGuire “Help me, help you gif”](https://media.giphy.com/media/uRb2p09vY8lEs/giphy.gif)

This file—often called CONTRIBUTING.md—gives guidelines for submitting your PR, including information like whether or not you need to write tests, the communication process, coding style, and how to submit your pull request. Check out [OpenSauced’s Contributing Guide](https://docs.opensauced.pizza/contributing/introduction-to-contributing/), as an example.
This file—often called CONTRIBUTING.md—gives guidelines for submitting your PR, including information like whether or not you need to write tests, the communication process, coding style, and how to submit your pull request. Check out [OpenSauced’s Contributing Guide](https://opensauced.pizza/docs/contributing/introduction-to-contributing/), as an example.

## Tips for Your First PR
Although every repository may have unique guidelines, there are general guidelines for all PRs. Here are some tips to keep in mind:
Expand All @@ -41,7 +41,7 @@ A well-written description will help the maintainer understand the purpose of th
3. Helps with future reference. A well-documented PR provides a historical record of the changes made. This helps future team members to understand the evolution of the code and the decisions made along the way. It also helps with future maintenance and debugging.

![OpenSauced's Examples for communication style](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/sc4v1pihnggpq0asu671.png)
<small> OpenSauced’s [CONTRIBUTING guidelines for communication style](https://docs.opensauced.pizza/contributing/introduction-to-contributing/) </small>
<small> OpenSauced’s [CONTRIBUTING guidelines for communication style](https://opensauced.pizza/docs/contributing/introduction-to-contributing/) </small>

### Link the issue
If the PR is related to an issue, you can link that issue and automatically close the issue when the PR is merged. One way to do this is to use this syntax: `closes #issue-number` for example, `closes #11`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,6 @@ Our hope is that the community will provide a safe space to discuss challenges,

5. **Making a Positive Impact**: Your contributions benefit other contributors who rely on these projects, fostering a sense of fulfillment and giving back to the community.

For more information on the challenge, like our upcoming events, including our Intro to Open Source Workshops, check out our [#100DaysOfOSS docs page](https://docs.opensauced.pizza/community/100-days-of-oss/). We'll have more great information and resources there on our launch day to help you on your journey. We'll also be dropping daily prompts on Twitter, so feel free to follow [@saucedopen](https://twitter.com/saucedopen) there for more inspiration.
For more information on the challenge, like our upcoming events, including our Intro to Open Source Workshops, check out our [#100DaysOfOSS docs page](https://opensauced.pizza/docs/community/100-days-of-oss/). We'll have more great information and resources there on our launch day to help you on your journey. We'll also be dropping daily prompts on Twitter, so feel free to follow [@saucedopen](https://twitter.com/saucedopen) there for more inspiration.

If you have any questions or suggestions, feel free to drop them below, so we can continue to work on supporting you in your open source adventure.
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Historically, collaborating on code involved manual file sharing or maintaining
2. **Effortless Synchronization**- By cloning repositories, team members can create local copies of the codebase. This means that everyone has their own version to work on and they can use Git to share the changes between repositories.

## Getting Started with Git
If you want to get some hands-on experience using git, check out OpenSauced's [Intro to Open Source Course](https://github.com/open-sauced/intro) or sign-up for one of our workshops that are listed on the bottom of our [#100DaysOfOSS Challenge docs](https://docs.opensauced.pizza/community/100-days-of-oss/).
If you want to get some hands-on experience using git, check out OpenSauced's [Intro to Open Source Course](https://github.com/open-sauced/intro) or sign-up for one of our workshops that are listed on the bottom of our [#100DaysOfOSS Challenge docs](https://opensauced.pizza/docs/community/100-days-of-oss/).

### Remote Repositories and Collaboration
Git allows for collaboration by enabling developers to work on the same codebase from remote locations.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ If a structured learning experience isn’t for you, you can also find a particu
### The Power of Online Communities

Over the last couple of years, online communities and forums have exploded with opportunity. I’m confident that there is a community that suits your needs out there already (but that doesn’t mean you can’t start your own if you can’t find one!) If you’re not sure where to start OpenSauced offers a lot of different opportunities to be part of a community and ask questions:
- [#100DaysOfOSS](https://docs.opensauced.pizza/community/100-days-of-oss/)
- [#100DaysOfOSS](https://opensauced.pizza/docs/community/100-days-of-oss/)
- [OpenSauced Community](https://github.com/orgs/open-sauced/discussions)
- [OpenSauced Twitter + Twitter Spaces](https://twitter.com/saucedopen)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ It took me longer than I anticipated, but I’m proud of getting my first PR acc
If you're considering making your first open-source contribution, I encourage you to get started today. Here are some gentle ways to get started in open source:

- Take our [Intro To Open Source Course](https://github.com/open-sauced/intro) to learn more about open source and how to get started.
- Join [#100DaysOfOSS](https://docs.opensauced.pizza/community/100-days-of-oss/)
- Join [#100DaysOfOSS](https://opensauced.pizza/docs/community/100-days-of-oss/)

If you have any questions or feedback, drop them in the comments below.

Expand Down
4 changes: 2 additions & 2 deletions blog/2023/2023-09-05-how-to-participate-in-hacktoberfest.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ Remember, Hacktoberfest isn't just about coding. Projects need help with documen
## Places for First-Time Contributors to Start
If you’re a first-time contributor, we’ve got you covered. One of our goals at OpenSauced is to make learning how to contribute to open source a positive experience. In preparation, we have documentation, a course (that gets you your first PR!), and support resources to help you get started and learn what you need to level up your open source experience.

- [#100DaysOfOSS](https://docs.opensauced.pizza/community/100-days-of-oss/)
- [Intro to Open Source Course](https://intro.opensauced.pizza/#/)
- [#100DaysOfOSS](https://opensauced.pizza/docs/community/100-days-of-oss/)
- [Intro to Open Source Course](https://opensauced.pizza/learn/#/)
- [pizza-verse repo](https://github.com/open-sauced/pizza-verse)
- [Open Source 101: A Beginner's Guide to Getting Started](https://dev.to/opensauced/open-source-101-a-beginners-guide-to-getting-started-37fb)
- [How to Contribute to Open Source without Knowing How to Code](https://dev.to/opensauced/how-to-contribute-to-open-source-without-knowing-how-to-code-a-guide-with-project-suggestions-59e5)
Expand Down
2 changes: 1 addition & 1 deletion blog/2023/2023-09-20-open-source-abcs-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Today, we're covering the letter "R" for Repository.

**Repository**: A repository is a central location where open-source projects store their source code, documentation, and related files. Platforms like GitHub and GitLab provide hosting services for repositories.

If you want to practice creating your own repository, check out [Practice Contributing with VS Code](https://intro.opensauced.pizza/#/04-tools-to-be-successful?id=practicing-contributing-with-vs-code) in our intro to open source course.
If you want to practice creating your own repository, check out [Practice Contributing with VS Code](https://opensauced.pizza/learn/#/04-tools-to-be-successful?id=practicing-contributing-with-vs-code) in our intro to open source course.

Now, we want to hear from you! What other OSS terms can you think of that start with the letter "R"?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Discover how to set up a GitHub Action that automatically posts a
---


A couple of months ago, we launched the [Intro to Open Source Course](https://intro.opensauced.pizza/#/), which connects to another repository called [guestbook](https://github.com/open-sauced/guestbook). When the person taking the course gets to chapter five, they put their new-found knowledge to work and create a pull request on the guestbook.
A couple of months ago, we launched the [Intro to Open Source Course](https://opensauced.pizza/learn/#/), which connects to another repository called [guestbook](https://github.com/open-sauced/guestbook). When the person taking the course gets to chapter five, they put their new-found knowledge to work and create a pull request on the guestbook.

<!-- truncate -->

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The description should explain what you’re submitting and give any necessary d


![This PR adds the AI PR description generation feature as suggested in #18. A new page is added to the extension dropdown to configure the description parameters. The text-generation is done using OpenAI's GPT-3.5 with the input context sourced from the code diff and/or the PR commits as configured by the user.
The feature documentation will be added to https://docs.opensauced.pizza.](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/u959rkuvmwehf44l7ebr.png)
The feature documentation will be added to https://opensauced.pizza/docs.](https://dev-to-uploads.s3.amazonaws.com/uploads/articles/u959rkuvmwehf44l7ebr.png)


### Type of PR
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Not everyone getting started in open source is a beginner. I’ve talked to quit

I keep a list of repositories that are good for beginners in this [insight page](https://app.opensauced.pizza/pages/BekahHW/655/repositories).

It’s worth noting that within that list, our [Intro to Open Source Course](https://intro.opensauced.pizza/#/) is a great
It’s worth noting that within that list, our [Intro to Open Source Course](https://opensauced.pizza/learn/#/) is a great
(and free) way to learn more about open source and get your first contribution!

### Where Should I Start in Open Source?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ So below you'll find a worksheet to help you identify and talk about your open s
| Next Project/Contribution Goal | [Your Next Goal in Open Source Contribution] |
| **Resume and Professional Profile Update** | |
| Updates Made to Resume/LinkedIn | [Details of Updates] |
| Key Accomplishments Highlighted | [Key Points [Highlighted](https://docs.opensauced.pizza/features/highlights/)] |
| Key Accomplishments Highlighted | [Key Points [Highlighted](https://opensauced.pizza/docs/features/highlights/)] |
| Future Plans for Profile Enhancement | [Plans for Further Enhancing Your Profile] |

Feel free to share and adapt this worksheet. We super stoked that @codergirl1991 is working on an [issue](https://github.com/open-sauced/docs/issues/203) for how to use OpenSauced for job seekers. So if there's more you'd like to see, let us know!
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ But I think it’s ok to think of putting a Minimum Viable Project (MVP) out the
## Code Review and Quality Control
### Basics

- **Understanding Basic Coding Standards**: These are rules or guidelines about how to write code for your project. They can include coding style, best practices, and how to structure code. You communicate these standards to new contributors usually through a document in your project repository, often named CONTRIBUTING.md. At OpenSauced, we have a [Contributing section](https://docs.opensauced.pizza/contributing/introduction-to-contributing/) in our docs to help explain how new contributors can get started.
- **Understanding Basic Coding Standards**: These are rules or guidelines about how to write code for your project. They can include coding style, best practices, and how to structure code. You communicate these standards to new contributors usually through a document in your project repository, often named CONTRIBUTING.md. At OpenSauced, we have a [Contributing section](https://opensauced.pizza/docs/contributing/introduction-to-contributing/) in our docs to help explain how new contributors can get started.
- **Conducting a PR Review**: When a contributor submits a Pull Request (PR), you need to check if their code follows your project’s standards and if it works well with existing code. This involves reading the code changes, understanding what they do, and testing them in your local environment. If the new code doesn't work well, you provide feedback to the contributor, suggesting necessary changes. You can find out more about PRs in these blog posts:
- [How to Get Your Pull Request Reviewed](https://dev.to/opensauced/how-to-get-your-pull-request-reviewed-kgd)
- [Understanding Why Pull Requests Get Rejected in Open Source Projects](https://dev.to/opensauced/understanding-why-pull-requests-get-rejected-in-open-source-projects-1jd0)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ We've also seen a good star-to-fork ratio and we've moving with strong velocity

## Our Teams

Our teams have been really hard at work launching a new features for OpenSauced called [workspaces](https://docs.opensauced.pizza/features/workspaces/) and that's reflected in the contributor insights page below.
Our teams have been really hard at work launching a new features for OpenSauced called [workspaces](https://opensauced.pizza/docs/features/workspaces/) and that's reflected in the contributor insights page below.

### Engineering

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ A cookie is a way to set a piece of user-specific data. This could be a session

Cookies that are [HTTP only](https://owasp.org/www-community/HttpOnly) can be accessed on the server-side, but for cookies that are not HTTP only, they can be accessed server-side and client-side. For example, you wouldn't want someone to tamper with your session ID on the client-side, so this type of cookie is set as HTTP only.

We recently shipped a new feature at OpenSauced, called [Workspaces](https://docs.opensauced.pizza/features/workspaces/). You can read all about it in this great post from my co-worker Bekah (@BekahHW).
We recently shipped a new feature at OpenSauced, called [Workspaces](https://opensauced.pizza/docs/features/workspaces/). You can read all about it in this great post from my co-worker Bekah (@BekahHW).

<a href="https://dev.to/opensauced/navigating-the-challenges-of-scaling-open-source-projects-11h2">https://dev.to/opensauced/navigating-the-challenges-of-scaling-open-source-projects-11h2</a>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Once you've identified people who would be good for the team, extend a formal in
5. Expand Your Horizons
Because open source projects are constantly growing and changing with the community, you should do a regular evaluation of the needs of the project.
- Identify areas that require specialized attention (documentation, community engagement, etc.).
- Talk to contributors with relevant expertise, even if they're outside your existing community. (You can use our [Contributor Insights feature](https://docs.opensauced.pizza/features/contributor-insights/) to understand which potential contributors might be a good fit.)
- Talk to contributors with relevant expertise, even if they're outside your existing community. (You can use our [Contributor Insights feature](https://opensauced.pizza/docs/features/contributor-insights/) to understand which potential contributors might be a good fit.)

6. Onboard New Team Members
- It's important to clearly define roles, responsibilities, communication channels, and project goals.
Expand All @@ -60,7 +60,7 @@ As your project gains traction, you might notice an influx of issues and pull re

Once you've identified potential team members, extend a formal invitation acknowledging their contributions. For example:

"Hey @contributor-username, I've noticed your dedication to this project through your insightful comments and high-quality pull requests. Would you be interested in joining our triage team? Your help would be invaluable in managing incoming issues and pull requests. Here's a link to our [Triage Guide](https://docs.opensauced.pizza/contributing/triage-guide/) with more information about how we approach triaging."
"Hey @contributor-username, I've noticed your dedication to this project through your insightful comments and high-quality pull requests. Would you be interested in joining our triage team? Your help would be invaluable in managing incoming issues and pull requests. Here's a link to our [Triage Guide](https://opensauced.pizza/docs/contributing/triage-guide/) with more information about how we approach triaging."

If they accept, grant them the appropriate permissions, such as the "Triage" permission on GitHub, which allows them to manage issues and pull requests without directly modifying the codebase.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ I've talked to a number of maintainers who have said they're looking for a solid

First of all, that's 100% ok. Not every project needs to support beginners. In fact, trying to support beginners when you don't have the bandwidth leads to burnout and frustration on both the maintainer and contributor side.

There are plenty of projects out there that can and do support beginner contributors, and there are courses, like our [Intro to Contributing Course](https://intro.opensauced.pizza/#/) that provide learning opportunities to new contributors.
There are plenty of projects out there that can and do support beginner contributors, and there are courses, like our [Intro to Contributing Course](https://opensauced.pizza/learn/#/) that provide learning opportunities to new contributors.

Here's [a great post by @adiatiayu on involving external contributors with issues](https://dev.to/opensauced/collaborate-conquer-grow-mastering-the-art-of-issue-management-for-open-source-projects-49gi).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ _Note: you can press enter in fields to submit a form, but again, not what we're

## How I Broke My Form

This brings us to a new feature that I was working on for OpenSauced for a few months, [workspaces](https://docs.opensauced.pizza/features/workspaces/). I encourage you to create your own, but for now, let's get back to the business of forms.
This brings us to a new feature that I was working on for OpenSauced for a few months, [workspaces](https://opensauced.pizza/docs/features/workspaces/). I encourage you to create your own, but for now, let's get back to the business of forms.

Here's our beautiful workspaces settings page that I implemented.

Expand Down
Loading

0 comments on commit 64ba379

Please sign in to comment.