Skip to content
This repository has been archived by the owner on Apr 29, 2024. It is now read-only.

feat: add "Additional Resources" and "Maintainers Guestbook" pages #75

Merged
merged 10 commits into from
Apr 23, 2024
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,35 +12,36 @@ Welcome to the Becoming a Maintainer Course with OpenSauced! This course is desi

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)
### [Intro: Understanding the Role of an Open Source Maintainer](intro.md)

### [How to Setup Your Open Source Project](/how-to-setup-your-project.md)
### [How to Setup Your Open Source Project](how-to-setup-your-project.md)

### [How to Handle Open Issues and Pull Requests](/issues-and-pull-requests.md)
### [How to Handle Open Issues and Pull Requests](issues-and-pull-requests.md)

### [Maintainer Power Ups](/maintainer-powerups.md)
### [Maintainer Power Ups](maintainer-powerups.md)

### [Building Your Open Source Dream Team](/your-team.md)
### [Building Your Open Source Dream Team](your-team.md)

### [Building and Nurturing a Welcoming and Supportive Community](/building-community.md)
### [Building and Nurturing a Welcoming and Supportive Community](building-community.md)

### [How to Communicate and Collaborate Effectively](/communication-and-collaboration.md)
### [How to Communicate and Collaborate Effectively](communication-and-collaboration.md)

### [How to Maintain Code Quality and Documentation](/maintaining-code-quality.md)
### [How to Maintain Code Quality and Documentation](maintaining-code-quality.md)

### [Let's Get Practical: Starting Your Project](/getting-practical.md)
### [Let's Get Practical: Starting Your Project](getting-practical.md)

### [The Power of Metrics and Analytics](/metrics-and-analytics.md)
### [The Power of Metrics and Analytics](metrics-and-analytics.md)

### 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.
- [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

To start the course, navigate to the [`intro` file](/intro.md) in the repository or visit the [Becoming a Maintainer Course with OpenSauced website](https://maintainer.opensauced.pizza/) and start reading! Each chapter builds on the previous one, so we recommend reading them in order.
To start the course, navigate to the [`intro` file](intro.md) in the repository or visit the [Becoming a Maintainer Course with OpenSauced website](https://maintainer.opensauced.pizza/) and start reading! 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.

Expand All @@ -60,9 +61,9 @@ Happy learning and contributing!

## 🤝 Contributing to this 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.
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).
If you want to translate our Becoming a Maintainer Course with OpenSauced course, check out our [🌐 i18n Guidelines](i18n-guidelines.md).

## ⚖️ LICENSE

Expand Down
25 changes: 12 additions & 13 deletions _layouts/sidebar.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
- **Chapters**

- [Open Source Maintainer](/intro.md)
- [Setting Up Your Project](/how-to-setup-your-project.md)
- [Issues and Pull Requests](/issues-and-pull-requests.md)
- [Maintainer Power Ups](/maintainer-powerups.md)
- [Setting Up Your Team](/your-team.md)
- [Building and Nurturing Community](/building-community.md)
- [Effective Communication and Collaboration](/communication-and-collaboration.md)
- [Maintaining Code Quality and Documentation](/maintaining-code-quality.md)
- [The Power of Metrics and Analytics](/metrics-and-analytics.md)
- [Let's Get Practical](/getting-practical.md)

- **Resources**
- [Resources](/resources.md)
- [Open Source Maintainer](intro.md)
- [Setting Up Your Project](how-to-setup-your-project.md)
- [Issues and Pull Requests](issues-and-pull-requests.md)
- [Maintainer Power Ups](maintainer-powerups.md)
- [Setting Up Your Team](your-team.md)
- [Building and Nurturing Community](building-community.md)
- [Effective Communication and Collaboration](communication-and-collaboration.md)
- [Maintaining Code Quality and Documentation](maintaining-code-quality.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)
21 changes: 21 additions & 0 deletions additional-resources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 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
- [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)
Binary file added assets/img/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.
6 changes: 5 additions & 1 deletion getting-practical.md
Original file line number Diff line number Diff line change
Expand Up @@ -367,4 +367,8 @@ Once your project is up and running, monitoring its health and activity is impor

You can learn more about how to create a successful project with OpenSauced with our [Maintainers Guide to OpenSauced](https://docs.opensauced.pizza/maintainers/maintainers-guide-to-open-sauced/).

Congratulations on creating your first project! Remember, these steps are guidelines; the key to a healthy open source project is to foster an open, inclusive, and collaborative environment.
---

Congratulations on creating your first project! Now, you can share it on our [Maintainers Guestbook](./maintainers-guestbook.md) page.

?> Remember, these steps are guidelines; the key to a healthy open source project is to foster an open, inclusive, and collaborative environment.
116 changes: 58 additions & 58 deletions index.html
Original file line number Diff line number Diff line change
@@ -1,61 +1,61 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>Open Sauced</title>
<link rel="icon" href="./assets/pizza-slice.png" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description" />
<meta
name="viewport"
content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
/>
<link
rel="stylesheet"
href="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/style.min.css"
title="docsify-darklight-theme"
type="text/css"
/>
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
themeColor: "#1797cf",
name: "Open Sauced",
repo: "open-sauced/maintainer-intro-course",
loadSidebar: "_layouts/sidebar.md",
loadNavbar: "_layouts/navbar.md",
relativePath: true,
subMaxLevel: 3,
search: "auto",
search: {
maxAge: 86400000,
paths: "auto",
placeholder: "Search",
noData: "No Results found!",
depth: 6,
hideOtherSidebarContent: false,
},
darklightTheme: {
bodyFontSize: "16px",
dark: {
accent: "#d44e70",
},
light: {
accent: "#4ed4d2",
},
},
auto2top: true
};
</script>
<!-- Docsify v4 -->
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-edit-on-github"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
<script
src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js"
type="text/javascript"
></script>
</body>
<head>
<meta charset="UTF-8" />
<title>Open Sauced</title>
<link rel="icon" href="./assets/img/pizza-slice.png" />
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description" />
<meta
name="viewport"
content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
/>
<link
rel="stylesheet"
href="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/style.min.css"
title="docsify-darklight-theme"
type="text/css"
/>
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
themeColor: "#1797cf",
name: "Open Sauced",
repo: "open-sauced/maintainer-intro-course",
loadSidebar: "_layouts/sidebar.md",
loadNavbar: "_layouts/navbar.md",
relativePath: true,
subMaxLevel: 3,
search: "auto",
search: {
maxAge: 86400000,
paths: "auto",
placeholder: "Search",
noData: "No Results found!",
depth: 6,
hideOtherSidebarContent: false,
},
darklightTheme: {
bodyFontSize: "16px",
dark: {
accent: "#d44e70",
},
light: {
accent: "#4ed4d2",
},
},
auto2top: true,
}
</script>
<!-- Docsify v4 -->
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-edit-on-github"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
<script
src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js"
type="text/javascript"
></script>
</body>
</html>
10 changes: 10 additions & 0 deletions maintainers-guestbook.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Maintainers Guestbook

Congratulations on finishing the Becoming a Maintainer Course with OpenSauced. Welcome to our Maintainers Guestbook, where you can share your first project with us!

## Projects List

<!-- Use below format to list your repository -->
<!--
- [project name](link to your repository) by [GitHub username](link to your GitHub profile)
-->