Skip to content

Commit

Permalink
feat: add "Becoming a Maintainer" course (#174)
Browse files Browse the repository at this point in the history
* 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
adiati98 and BekahHW authored Apr 26, 2024
1 parent 5476877 commit 4b63c80
Show file tree
Hide file tree
Showing 54 changed files with 2,180 additions and 80 deletions.
File renamed without changes.
40 changes: 18 additions & 22 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Contributions are always welcome, no matter how large or small. Before contribut

- If you wish to work on an open issue, please comment with `.take`, and it will be assigned to you. If an issue is not assigned, it is assumed to be available for anyone to work on. So, assign yourself to an issue before beginning work to avoid conflicts.

- Do you have an idea and want to add a section or a chapter to this course? Or do you spot a bug or have an idea for enhancing our course? You can create an issue to address it. But our maintainers need to triage the issue before you can work on it. If you wish to work on the issue, please tag the `@open-sauced/docs` team in the comment to notify them.
- Do you have an idea and want to add a section or a chapter to a course? Or do you spot a bug or have an idea for enhancing any of our courses? You can create an issue to address it. But our maintainers need to triage the issue before you can work on it. If you wish to work on the issue, please tag the `@open-sauced/docs` team in the comment to notify them.

You can always ask for help in the `🍕opensauced-contributors-chat` channel on our community [Discord](https://discord.com/invite/U2peSNf23P) or [GitHub Discussions](https://github.com/open-sauced/intro/discussions) if you get stuck while working on your changes or need clarification.

Expand All @@ -27,7 +27,7 @@ You can always ask for help in the `🍕opensauced-contributors-chat` channel on
2. [Clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) the forked repository to your local machine.

```bash
git clone https://github.com/<your-username>/intro.git
git clone https://github.com/YOUR-USERNAME/intro.git
```

3. Navigate to and open the project in your code editor.
Expand Down Expand Up @@ -120,11 +120,13 @@ Live Server extension allows you to launch a local development server and previe

## Working with the Content

The contents of this course are written in [Markdown](https://www.markdownguide.org/). Please read the "[Using Markdown for This Project](#using-markdown-for-this-project)" section for details about how to use Markdown in this project.
The contents of our courses are written in [Markdown](https://www.markdownguide.org/), a lightweight and easy-to-use markup language that allows you to format text in a readable and visually appealing way.

Please read the "[Using Markdown for This Project](#using-markdown-for-this-project)" section for details about how to use it in this project.

### Adding Definitions to the Glossary

If you add definitions to the "[Glossary](./intro-to-oss/glossary.md)" chapter, ensure the definitions are added in **alphabetical order**.
If you add definitions to the "Glossary" chapter in the [Intro to Open Source](./intro-to-oss/glossary.md) or [Becoming a Maintainer](./becoming-a-maintainer/glossary.md) course, ensure the definitions are added **alphabetically**.

### Adding a New Section to a Chapter

Expand All @@ -134,7 +136,7 @@ You can add a new chapter if it's more suitable for a standalone section.

### Adding a New Chapter and Adding it to the Sidebar

In this section, we will walk you through how to add a new chapter to our Intro to Open Source course and add it to the sidebar.
In this section, we will walk you through adding a new chapter to any of our courses and adding it to the sidebar.

#### Adding a New Chapter

Expand Down Expand Up @@ -191,15 +193,9 @@ After your contribution is accepted, your new chapter will become part of our co

## Using Markdown for This Project

We have a [style guide](https://github.com/open-sauced/pizza-verse/blob/main/style-guide.md) to use Markdown for our projects. So, when contributing to this project, you must follow this convention.

### Markdown Basics

Markdown is a lightweight and easy-to-use markup language that allows you to format text in a readable and visually appealing way.

Below are some Markdown elements that you will commonly use in this project with examples, following our style guide:
When contributing to this project, you must follow our Markdown convention below:

#### 1. Headings
### 1. Headings

Use the hash (`#`) symbol to create headings (titles and subtitles). There are six levels of section headings, and the number of symbols indicates the heading level.

Expand All @@ -209,7 +205,7 @@ Use the hash (`#`) symbol to create headings (titles and subtitles). There are s
## Heading 2
```

#### 2. Text Formatting
### 2. Text Formatting

- Make text bold by enclosing it with double asterisks (`**`).
- Make text italic by enclosing it with single underscores (`_`).
Expand All @@ -223,7 +219,7 @@ _This is an italic text._
This is an `inline code`.
```

#### 3. Lists
### 3. Lists

- Create ordered lists using numbers followed by a period (`1.`, `2.`, etc.).
- Create unordered lists using hyphens (`-`).
Expand All @@ -236,31 +232,31 @@ This is an `inline code`.
- Unordered Item 2
```

#### 4. Links
### 4. Links

Create links using square brackets (`[]`) for the link text and parentheses (`()`) for the URL.

```markdown
[Intro to Open Source with OpenSauced](https://intro.opensauced.pizza/#/)
[Open Source Education Path with OpenSauced](https://intro.opensauced.pizza/#/)
```

#### 5. Images
### 5. Images

Embed images using an exclamation mark (`!`), followed by square brackets (`[]`) for the alt text, and parentheses (`()`) for the image URL.

```markdown
![Create new repository on GitHub](../_assets/images/new-repo.png)
```

#### 6. Blockquotes
### 6. Blockquotes

Create blockquotes using the greater-than symbol (`>`).

```markdown
> This is a blockquote.
```

#### 7. Code Blocks
### 7. Code Blocks

Create code blocks using triple backticks (` ``` `) for fenced code blocks and specify a language next to the backticks before the fenced code block to highlight the syntax.

Expand All @@ -278,6 +274,6 @@ git pull
- Use code blocks to highlight code snippets or configuration examples.
- Check out the official [Markdown Guide](https://www.markdownguide.org/basic-syntax/) website for more information about using Markdown.

## Translating the Intro to Open Source Course
## Translating the Courses

Translating our Intro to Open Source course helps make it more accessible to a broader audience. If you're interested in translating this course, please read our [🌐 i18n Guidelines](i18n-guidelines.md) page.
Translating our Intro to Open Source and Becoming a Maintainer courses helps make them more accessible to a broader audience. If you want to translate one of these courses, please read our [🌐 i18n Guidelines](i18n-guidelines.md) page.
21 changes: 14 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
<div align="center">
<img alt="OpenSauced" src="https://i.ibb.co/7jPXt0Z/logo1-92f1a87f.png" width="300px">
<h1>🍕 Open Source Education Path with OpenSauced 🍕</h1>

<div style="text-align: center; padding: 20px;">
<h1 style="font-size: 3em; font-family: 'Arial', sans-serif; font-weight: bold; margin: 10px 0;">
The Open Source Education Path with
<span style="background: linear-gradient(to right, #e74c3c, #e67e22); -webkit-background-clip: text; color: transparent;">
OpenSauced
</span> </h1>
</div>

Welcome to the Open Source Education Path with OpenSauced!

**Welcome to the Open Source Education Path with OpenSauced!**

Open source projects offer potential for personal growth, networking and collaboration, and meaningful community contributions. Because of this, there is a growing interest in open source and a need for resources to help people get started.

Expand All @@ -15,17 +20,19 @@ At OpenSauced, we aim to empower contributors, maintainers, and teams in open so

This course is designed to equip you with the skills and knowledge you need to contribute to open source projects. It offers engaging exercises to help you begin your journey towards becoming a successful contributor, and even provides an opportunity to get your first pull request merged.

**Head to our [Intro to Open Source](./intro-to-oss/README.md) course to start your learning journey!**
**Head to our [Intro to Open Source](./intro-to-oss/README.md) course to start your contributing learning journey!**

### Becoming a Maintainer — Coming Soon!
### Becoming a Maintainer

This course is designed to aid people who are interested in becoming open source project maintainers. It guides you through maintainers' best practices and provides resources and tools that help maintainers perform their tasks. This course is equipped with a tutorial for you to get practical.

**Head to our [Becoming a Maintainer](./becoming-a-maintainer/README.md) course to start your maintainer learning journey!**

## **Contributing to Our Courses**

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 Intro to Open Source course, check out our [🌐 i18n Guidelines](i18n-guidelines.md).
If you want to translate our Intro to Open Source or Becoming a Maintainer course, check out our [🌐 i18n Guidelines](i18n-guidelines.md).

## **Community**

Expand Down
Binary file added docs/_assets/gifs/create-github-project.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/gifs/highlight.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/gifs/issues-template.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/gifs/org-permissions.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/gifs/saved-replies.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/gifs/set-up-repo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/gifs/team-sync-insights.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/gifs/team-sync.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/activity-repos-insights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/contrib-insight-new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/contributors-insights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/create-issue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/failed-automated-tests.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/feature-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/gh-actions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/list-graph.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/logo-on-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/org-permissions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_assets/images/pizza-slice.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/pr-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/repos-insights.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/slice-Gradient-White.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_assets/images/workspace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions docs/_navbar.md
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)
2 changes: 2 additions & 0 deletions docs/_sidebar.md
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](/)
96 changes: 96 additions & 0 deletions docs/becoming-a-maintainer/README.md
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>
5 changes: 5 additions & 0 deletions docs/becoming-a-maintainer/_navbar.md
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)
16 changes: 16 additions & 0 deletions docs/becoming-a-maintainer/_sidebar.md
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)
26 changes: 26 additions & 0 deletions docs/becoming-a-maintainer/additional-resources.md
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>
Loading

0 comments on commit 4b63c80

Please sign in to comment.