-
-
Notifications
You must be signed in to change notification settings - Fork 117
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add "Becoming a Maintainer" course (#174)
* feat: create becoming-a-maintainer folder and move maintainer course's files * feat: add assets for maintainer course * fix: internal links to assests * fix: internal links path * fix: change term tab to dashboard for consistency accross courses and minor wording adjustments * fix: minor wordings * chores: move .nojekyll to the root of docs * feat: add footer to edit page * fix: update homepage navbar * fix: update maintainer course navbar * fix: add link to maintainer course on intro to oss navbar * feat: update homepage README to include link to maintainer course and minor wording adjustments * feat: update i18n guidelines to include maintainer course * feat: update community-translations.md * feat: update CONTRIBUTING to include maintainer course * chores(index.html): add alias for maintainer course sidebar and navbar * fix: modify style for accessibility * feat: add a sentence in each chapter to navigate to the next one to accomodate github * fix: wording in homepage README * fix: relative paths * fix: remove community-translations.md from becoming-a-maintainer * Replace pizza slice with gradient * Update light theme to be similar to docs repo * Adjust dark mode to reflect docs theme * Maintain consistency by bolding key words in list * Change the favicon icon * Change the favicon icon * Adjust header img * Change header style * Stylize heading on readme * Stylize heading on readme * Add logo * Add link to sidebar logo * Add darker color for accessibility * Add alt * Change to full title * Change sidebar title * Update username in links * fix: wording in Getting Started section on both courses' README for consistency * fix: remove double quotes for dashboard * fix: wording * fix: hex color for accessibility in custom.css * fix: wording of becoming a maintainer * Use with for consistency * Implement Ayu's style suggestions * Implement new styles on intro course * Remove that logo * Bump up title size --------- Co-authored-by: Bekah Hawrot Weigel <rhawrot@gmail.com>
- Loading branch information
Showing
54 changed files
with
2,180 additions
and
80 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains 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
This file contains 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,9 @@ | ||
<!-- - Menu --> | ||
<!-- - [Intro to Open Source](/intro-to-oss/) --> | ||
<!-- - [Becoming a Maintainer](/becoming-maintainer/) --> | ||
- [Homepage](../README.md) | ||
|
||
- [Homepage](README.md) | ||
- Courses | ||
- [Intro to Open Source](/intro-to-oss/README.md) | ||
- Becoming a Maintainer - Coming Soon! | ||
- [Becoming a Maintainer](/becoming-a-maintainer/README.md) | ||
- [⭐ Star The Repo](https://github.com/open-sauced/intro) |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,3 @@ | ||
[![OpenSauced Logo](../_assets/images/logo-on-dark.png)](https://opensauced.pizza/) | ||
|
||
- [Open Source Education Path](/) |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
<div align="center" style="text-align: center;"> | ||
<div style="display: flex; align-items: center; justify-content: center;"> | ||
<h1 style="font-size: 3em; font-family: 'Arial', sans-serif; font-weight: bold; margin: 25px 0;">Becoming a Maintainer with <span style="background: linear-gradient(to right, #e74c3c, #e67e22); -webkit-background-clip: text; color: transparent;"> | ||
OpenSauced | ||
</span> </h1> | ||
</div> | ||
</div> | ||
|
||
Welcome to the Becoming a Maintainer Course with OpenSauced! This course is designed to provide you with an introduction to how to become an open source maintainer and guide you through the process of creating your open source project, working with contributors, and more. | ||
|
||
## Course Overview | ||
|
||
The course is divided into chapters, with each covering a different aspect of being an open source maintainer: | ||
|
||
### [Intro: Understanding the Role of an Open Source Maintainer](intro.md) | ||
|
||
This chapter introduces the role of maintainers in open source, the benefits and the responsibilities of becoming a maintainer, and the challenges they face. | ||
|
||
### [How to Setup Your Open Source Project](how-to-setup-your-project.md) | ||
|
||
This chapter walks you through the crucial elements necessary for every project to succeed during its initial setup. | ||
|
||
### [How to Handle Open Issues and Pull Requests](issues-and-pull-requests.md) | ||
|
||
In this chapter, you'll learn how to manage open issues and pull requests in your project, from triaging issues to reviewing pull requests. | ||
|
||
### [How to Communicate and Collaborate Effectively](communication-and-collaboration.md) | ||
|
||
This chapter will discuss onboarding new contributors, utilizing different communication channels for your open source project's community, and maintaining healthy communication. | ||
|
||
### [How to Maintain Code Quality and Documentation](maintaining-code-quality.md) | ||
|
||
This chapter covers ways of maintaining code quality and documentation in your open source project. | ||
|
||
### [Building and Nurturing a Welcoming and Supportive Community](building-community.md) | ||
|
||
In this chapter, you will learn how to build and nurture a welcoming and supportive community in open source, particularly around your project. | ||
|
||
### [Maintainer Power Ups](maintainer-powerups.md) | ||
|
||
This chapter introduces tools on GitHub that you can utilize to help you save some time, make your work lighter, and boost your productivity as a maintainer. | ||
|
||
### [Building Your Open Source Dream Team](your-team.md) | ||
|
||
In this chapter, you'll learn how to create and assemble your team by examining effective collaboration and offering guidance on identifying, onboarding, and empowering your open source squad. | ||
|
||
### [The Power of Metrics and Analytics](metrics-and-analytics.md) | ||
|
||
This chapter will help you understand your project's metrics and guide you through understanding, leveraging, and making decisions based on these metrics to create a thriving open source project. | ||
|
||
### [Let's Get Practical: Starting Your Project](getting-practical.md) | ||
|
||
This chapter contains tutorials based on the previous chapters to help you prepare and launch your first open source project as a maintainer. | ||
|
||
### Additional Information | ||
|
||
As this is the beginning of your open source maintainer journey, we've also provided additional information in these chapters: | ||
|
||
- [Glossary](glossary.md): A glossary of common terms and definitions used by open source maintainers. | ||
- [Additional Resources](additional-resources.md): A list of resources for further learning about open source maintainers. | ||
|
||
## Getting Started | ||
|
||
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! | ||
|
||
?> **Tip:** Each chapter builds on the previous one, so we recommend reading them in order. | ||
|
||
As you work through the course, we encourage you to experiment with the tools and concepts covered in the chapters. | ||
|
||
## Building Your Open Source Resume | ||
|
||
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. | ||
|
||
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/). | ||
|
||
--- | ||
|
||
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 [OpenSauced community Discord](https://discord.com/invite/U2peSNf23P). | ||
|
||
Happy learning and contributing! | ||
|
||
--- | ||
|
||
## 🤝 Contributing to OpenSauced Becoming a Maintainer Repository | ||
|
||
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 Guidelines](../CONTRIBUTING.md) for information on how to contribute. | ||
|
||
If you want to translate our Becoming a Maintainer Course with OpenSauced course, check out our [🌐 i18n Guidelines](../i18n-guidelines.md). | ||
|
||
## ⚖️ LICENSE | ||
|
||
[![Creative Commons License](https://i.creativecommons.org/l/by/4.0/88x31.png)](https://creativecommons.org/licenses/by/4.0/) | ||
|
||
<footer> | ||
<a href="https://github.com/open-sauced/intro/blob/main/docs/becoming-a-maintainer/README.md">✏️ Edit this page</a> | ||
</footer> |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
- [Homepage](../README.md) | ||
- Courses | ||
- [Intro to Open Source](/intro-to-oss/README.md) | ||
- [Becoming a Maintainer](/becoming-a-maintainer/README.md) | ||
- [⭐ Star The Repo](https://github.com/open-sauced/intro) |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
[![OpenSauced Logo](../_assets/images/logo-on-dark.png)](https://opensauced.pizza/) | ||
|
||
- **Chapters** | ||
|
||
- [Understanding Maintainership](intro.md) | ||
- [Setting Up Your Project](how-to-setup-your-project.md) | ||
- [Managing Issues and Pull Requests](issues-and-pull-requests.md) | ||
- [Effective Communication and Collaboration](communication-and-collaboration.md) | ||
- [Maintaining Code Quality and Documentation](maintaining-code-quality.md) | ||
- [Building and Nurturing Community](building-community.md) | ||
- [Maintainer Power Ups](maintainer-powerups.md) | ||
- [Setting Up Your Team](your-team.md) | ||
- [The Power of Metrics and Analytics](metrics-and-analytics.md) | ||
- [Let's Get Practical](getting-practical.md) | ||
- [Maintainers Guestbook](maintainers-guestbook.md) | ||
- [Additional Resources](additional-resources.md) |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Additional Resources | ||
|
||
On this page, you will find additional resources to help you learn more about all things around open source maintainers. | ||
|
||
## Guides | ||
|
||
- [Open Source Guide](https://opensource.guide/) by GitHub: Open Source Guides are a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open-source project. | ||
- [Contributor Ladder Template](https://github.com/cncf/project-template/blob/main/CONTRIBUTOR_LADDER.md) by cncf: This is a template for a contributor ladder that outlines the different contributor roles within a project, along with the responsibilities and privileges that come with them. | ||
- [Maintainer Community](https://maintainers.github.com/auth/signin) by GitHub: The Maintainer Community is a private space for maintainers to connect with peers, preview GitHub features, and help GitHub support the open source community. | ||
|
||
## Blog Posts | ||
|
||
- [New Maintainer Resources Series](https://dev.to/bekahhw/series/25520) | ||
- [Maintainer Toolkit Series](https://dev.to/bekahhw/series/24725) by BekahHW | ||
- [Maintainer Toolkit Series](https://dev.to/nickytonline/series/24726) by Nick Taylor | ||
- [The Missing Piece: Why Your Project Needs a Maintainer Onboarding Process](https://dev.to/opensauced/the-missing-piece-why-your-project-needs-a-maintainer-onboarding-process-np0) | ||
- [Scaling Open Source Projects: Navigating Challenges](https://dev.to/opensauced/navigating-the-challenges-of-scaling-open-source-projects-11h2) | ||
- [Collaborate, Conquer, & Grow: Mastering the Art of Issue Management for Open Source Projects](https://dev.to/opensauced/collaborate-conquer-grow-mastering-the-art-of-issue-management-for-open-source-projects-49gi) | ||
- [The Lonely Journey of Open-Source Maintainers: A Call for Connection and Recognition](https://dev.to/opensauced/the-lonely-journey-of-open-source-maintainers-a-call-for-connection-and-recognition-2ghe) | ||
- [The Role of Documentation in Open Source Success](https://dev.to/opensauced/the-role-of-documentation-in-open-source-success-2lbn) | ||
- [How To Make a Delicious Contributing Guide](https://dev.to/opensauced/how-to-make-a-delicious-contributing-guide-4bp3) | ||
- [What Does an Open Source Triage Team Do?](https://dev.to/opensauced/what-does-an-open-source-triage-team-do-2egd) | ||
|
||
<footer> | ||
<a href="https://github.com/open-sauced/intro/blob/main/docs/becoming-a-maintainer/additional-resources.md">✏️ Edit this page</a> | ||
</footer> |
Oops, something went wrong.