Skip to content

Commit 1b78138

Browse files
authored
chore: seo updates (OpenSource-Communities#233)
* Optimize for advantages and benefits of oss * Optimize for history and license * link to repo pages * Optimize for open source community * Optimize for open source metrics * Optimize for How to start an open source project * Optimize for how to contribute to open source * Optimize for how to contribute in * Updates docs path * Update from intro. to learn * Remove repetition
1 parent 392475a commit 1b78138

16 files changed

+81
-71
lines changed

.github/workflows/maintainer_course.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ jobs:
1616
- name: Post comment for course contributors
1717
if: contains(github.event.pull_request.title, 'adds repo to guestbook')
1818
run: |
19-
PR_COMMENT="Congratulations on completing the Becoming a Maintainer Course with your contribution to this repository, @${{ github.actor }}! We'd love to continue to amplify your project. Here are some ways to do that: Create a [highlight](https://app.opensauced.pizza/feed) of your contribution to our guestbook — [more info here](https://docs.opensauced.pizza/features/highlights/) — and share it with us in our [Becoming a Maintainer Course discussion](https://github.com/orgs/open-sauced/discussions/35)!"
19+
PR_COMMENT="Congratulations on completing the Becoming a Maintainer Course with your contribution to this repository, @${{ github.actor }}! We'd love to continue to amplify your project. Here are some ways to do that: Create a [highlight](https://app.opensauced.pizza/feed) of your contribution to our guestbook — [more info here](https://opensauced.pizza/docs/features/highlights/) — and share it with us in our [Becoming a Maintainer Course discussion](https://github.com/orgs/open-sauced/discussions/35)!"
2020
curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" -X POST -d "{\"body\":\"$PR_COMMENT\"}" "https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/comments"

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
This repository is the home of OpenSauced courses for people who want to learn to contribute to open source projects and for people who want to become project maintainers.
1111

12-
Head over to the **[Intro to Open Source Course](./docs/intro-to-oss/README.md)** or **[Becoming A Maintainer Course](./docs/becoming-a-maintainer/README.md)** on GitHub to start learning! Alternatively, visit [The Open Source Education Path with OpenSauced website](https://intro.opensauced.pizza/).
12+
Head over to the **[Intro to Open Source Course](./docs/intro-to-oss/README.md)** or **[Becoming A Maintainer Course](./docs/becoming-a-maintainer/README.md)** on GitHub to start learning! Alternatively, visit [The Open Source Education Path with OpenSauced website](https://opensauced.pizza/learn).
1313

1414
## **🤝 Contributing**
1515

contributing/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to OpenSauced Intro
22

3-
Contributions are always welcome, no matter how large or small. Before contributing, please read the [Code of Conduct](https://docs.opensauced.pizza/contributing/code-of-conduct/) and follow the directions in this guide.
3+
Contributions are always welcome, no matter how large or small. Before contributing, please read the [Code of Conduct](https://opensauced.pizza/docs/contributing/code-of-conduct/) and follow the directions in this guide.
44

55
## Recommended Communication Style
66

@@ -279,7 +279,7 @@ This is an `inline code`.
279279
Create links using square brackets (`[]`) for the link text and parentheses (`()`) for the URL.
280280

281281
```markdown
282-
[Open Source Education Path with OpenSauced](https://intro.opensauced.pizza/#/)
282+
[Open Source Education Path with OpenSauced](https://opensauced.pizza/learn/)
283283
```
284284

285285
### 5. Images

docs/becoming-a-maintainer/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ As this is the beginning of your open source maintainer journey, we've also prov
6060

6161
## Getting Started
6262

63-
If you are taking this course on our GitHub repository, navigate to the [`intro.md` file](intro.md) to start the course. Alternatively, visit the [Becoming a Maintainer with OpenSauced on the website](https://intro.opensauced.pizza/#/becoming-a-maintainer/) and start reading!
63+
If you are taking this course on our GitHub repository, navigate to the [`intro.md` file](intro.md) to start the course. Alternatively, visit the [Becoming a Maintainer with OpenSauced on the website](https://opensauced.pizza/learn/becoming-a-maintainer/) and start reading!
6464

6565
:::tip
6666

@@ -74,7 +74,7 @@ As you work through the course, we encourage you to experiment with the tools an
7474

7575
One of the unique features of this course is that it guides you to build your open source resume using OpenSauced. OpenSauced is a platform that helps you track and showcase your open source contributions, making it easier to get noticed by potential employers and collaborators.
7676

77-
To learn more about using OpenSauced to build your open source project, check out the [Maintainers Guide to OpenSauced](https://docs.opensauced.pizza/maintainers/maintainers-guide-to-open-sauced/).
77+
To learn more about using OpenSauced to build your open source project, check out the [Maintainers Guide to OpenSauced](https://opensauced.pizza/docs/maintainers/maintainers-guide-to-open-sauced/).
7878

7979
---
8080

docs/becoming-a-maintainer/building-community.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,29 @@ keywords: ["building community", "building open source community", "nurturing co
77

88
Open source is more than just maintaining and improving a project. It's a dynamic environment where maintainers, contributors, and users come together to collaborate, contribute, and grow. That said, the people involved in the project are the core and heart of open source.
99

10-
As more people engage and contribute to your projects, it becomes crucial for you to provide them with the necessary support and motivation to establish a welcoming and positive community environment. Doing so can build stronger relationships and promote a sense of belonging among your community members, keeping them returning and remaining dedicated.
10+
As more people engage and contribute to your projects, it becomes crucial for you to provide them with the necessary support and motivation to establish a welcoming and positive open source community environment. Doing so can build stronger relationships and promote a sense of belonging among your community members, keeping them returning and remaining dedicated.
1111

12-
In this chapter, you will learn how to build and nurture a welcoming and supportive community in open source.
12+
In this chapter, you will learn how to build and nurture a welcoming and supportive open source community.
1313

1414
## Positive Community Culture
1515

1616
There are many types of people when talking about engagements in a community. Some are actively engaging, some come and go, and some are lurkers. But one thing is sure: everyone has the same interest (your project), and they bring value to your project. You always want to ensure everyone feels welcomed, included, and, most importantly, safe in your community. One key to achieving this is fostering a positive community culture.
1717

1818
### Open Communication
1919

20-
You want to encourage open communication in the community. Open communication allows everyone to understand what's happening around the project and community, helps build trust, and increases healthy collaboration. Everyone should feel comfortable expressing thoughts and ideas, but at the same time, they should be able to listen and respectfully respond to others. For tips about communication and collaboration, read the chapter "[How to Communicate and Collaborate Effectively](communication-and-collaboration.md)."
20+
Successful open source communities encourage open communication. Open communication allows everyone to understand what's happening around the project and community, helps build trust, and increases healthy collaboration. Everyone should feel comfortable expressing thoughts and ideas, but at the same time, they should be able to listen and respectfully respond to others. For tips about communication and collaboration, read the chapter "[How to Communicate and Collaborate Effectively](communication-and-collaboration.md)."
2121

2222
### Diversity and Inclusivity
2323

2424
Creating a safe and welcoming community environment involves prioritizing inclusion and promoting diversity. Inclusion means treating everyone with value, regardless of background, beliefs, or opinions. By fostering a culture where everyone is encouraged to be authentic while appreciating others, you can nurture a community where everyone feels respected and valued. Building a community where everyone feels they belong is the most important thing.
2525

2626
### Code of Conduct
2727

28-
Every open source project should have a code of conduct as a clear set of guidelines for how members within the community should behave and treat each other. You can, for example, emphasize the importance of using positive and inclusive language, treating others with respect, and avoiding discrimination or harassment. Inform them of the consequences they may face if they do not follow the guidelines. A code of conduct helps to prevent conflicts, promotes respect, and ensures that everyone in the community feels safe and comfortable. You can read the "[Code of Conduct](how-to-setup-your-project.md#code-of-conduct)" section in the "How to Setup Your Open Source Project" chapter to create one.
28+
Every project should have a code of conduct as a clear set of guidelines for how members within the open source community should behave and treat each other. You can, for example, emphasize the importance of using positive and inclusive language, treating others with respect, and avoiding discrimination or harassment. Inform them of the consequences they may face if they do not follow the guidelines. A code of conduct helps to prevent conflicts, promotes respect, and ensures that everyone in the community feels safe and comfortable. You can read the "[Code of Conduct](how-to-setup-your-project.md#code-of-conduct)" section in the "How to Setup Your Open Source Project" chapter to create one.
2929

3030
### Addressing Conflicts
3131

32-
Imagine seeing a member behave disrespectfully towards another member on GitHub or Discord, or receiving an incident report from a member saying someone harassed them. Addressing conflicts is crucial to fostering a positive culture. If you don't promptly resolve them, your community will no longer feel safe and will lose trust in you. You can learn more about managing conflicts in the "[Handling Difficult Situations](communication-and-collaboration.md#handling-difficult-situations)" section in the "How to Communicate and Collaborate Effectively" chapter.
32+
Imagine seeing a member behave disrespectfully towards another member on GitHub or Discord, or receiving an incident report from a member saying someone harassed them. Unfortunately, most open source communities will have to address conflicts at some point. Being prepared to do so will help to maintain a positive culture. You can learn more about managing conflicts in the "[Handling Difficult Situations](communication-and-collaboration.md#handling-difficult-situations)" section in the "How to Communicate and Collaborate Effectively" chapter.
3333

3434
### Leading by Examples
3535

@@ -91,11 +91,11 @@ Some of your contributors may have skills that can be useful to promote your pro
9191

9292
#### Managing Issues
9393

94-
Issue management involves identifying, analyzing, and prioritizing bug issues and feature requests during development. You can create a triage team and encourage your community to help you triage and prioritize the issues in your repositories. You want to equip them with a clear guide on managing issues like what we have at OpenSauced in our [Triage Guide](https://docs.opensauced.pizza/contributing/triage-guide/). You can also read [this article](https://dev.to/opensauced/collaborate-conquer-grow-mastering-the-art-of-issue-management-for-open-source-projects-49gi) to learn more about issue management.
94+
Issue management involves identifying, analyzing, and prioritizing bug issues and feature requests during development. You can create a triage team and encourage your community to help you triage and prioritize the issues in your repositories. You want to equip them with a clear guide on managing issues like what we have at OpenSauced in our [Triage Guide](https://opensauced.pizza/docs/contributing/triage-guide/). You can also read [this article](https://dev.to/opensauced/collaborate-conquer-grow-mastering-the-art-of-issue-management-for-open-source-projects-49gi) to learn more about issue management.
9595

9696
#### Community Events and Hackathons
9797

98-
At OpenSauced, we organize the [#100DaysOfOSS challenge](https://docs.opensauced.pizza/community/100-days-of-oss/) to encourage contributors of all technical backgrounds to immerse themselves in collaborative development and engage with a supportive community.
98+
At OpenSauced, we organize the [#100DaysOfOSS challenge](https://opensauced.pizza/docs/community/100-days-of-oss/) to encourage contributors of all technical backgrounds to immerse themselves in collaborative development and engage with a supportive community.
9999

100100
Organizing community events and hackathons is one way to strengthen your community's collaboration and relationships. You can create a survey or poll to gather feedback on what events your community wants to see. Then, consider forming a committee or group of members interested in organizing the events and letting them take charge with your support. By allowing your members to get involved and contribute, you can increase the sense of community and belonging.
101101

@@ -109,17 +109,17 @@ To foster the growth of these new talents, you can provide them with mentorship,
109109

110110
### Identify New Talents with OpenSauced
111111

112-
You can utilize OpenSauced [Repository Insights](https://docs.opensauced.pizza/features/repo-insights/) and [Contributor Insights](https://docs.opensauced.pizza/features/contributor-insights/) features to identify new talents by tracking active project contributors.
112+
You can utilize OpenSauced [Repository Insights](https://opensauced.pizza/docs/features/repo-insights/) and [Contributor Insights](https://opensauced.pizza/docs/features/contributor-insights/) features to identify new talents by tracking active project contributors.
113113

114114
#### 1. Using Repository Insights
115115

116116
You can list the projects you maintain on a Repository Insights Page. This feature allows you to monitor your projects' activity and identify contributors who actively contribute to and impact them.
117117

118-
You can find more information about your contributors in the Contributors dashboard. It allows you to view their activity level, the date of their last contribution, and the number of contributions. It also gives you information on their time zone and the languages they use most. Learn more about Repository Insights for maintainers and how to create one on [OpenSauced Docs](https://docs.opensauced.pizza/maintainers/maintainers-guide-to-open-sauced/#repository-insights-connecting-your-repositories).
118+
You can find more information about your contributors in the Contributors dashboard. It allows you to view their activity level, the date of their last contribution, and the number of contributions. It also gives you information on their time zone and the languages they use most. Learn more about Repository Insights for maintainers and how to create one on [OpenSauced Docs](https://opensauced.pizza/docs/maintainers/maintainers-guide-to-open-sauced/#repository-insights-connecting-your-repositories).
119119

120120
#### 2. Using Contributor Insights
121121

122-
After identifying potential new talents for your projects, you can select and add them to the list of a new or existing Contributor Insights Page. This feature enables you to monitor and analyze your contributors' activity levels and contributions more deeply, such as tracking the number of commits and pull requests they have made. You can read more about Contributor Insights for maintainers and how to create one on [OpenSauced Docs](https://docs.opensauced.pizza/maintainers/maintainers-guide-to-open-sauced/#contributor-insights-connecting-with-contributors).
122+
After identifying potential new talents for your projects, you can select and add them to the list of a new or existing Contributor Insights Page. This feature enables you to monitor and analyze your contributors' activity levels and contributions more deeply, such as tracking the number of commits and pull requests they have made. You can read more about Contributor Insights for maintainers and how to create one on [OpenSauced Docs](https://opensauced.pizza/docs/maintainers/maintainers-guide-to-open-sauced/#contributor-insights-connecting-with-contributors).
123123

124124
## Conclusion
125125

0 commit comments

Comments
 (0)