From 85d2dcbc6a440c76a9bff762080e1ced7066849a Mon Sep 17 00:00:00 2001 From: Ayu Adiati <45172775+adiati98@users.noreply.github.com> Date: Tue, 23 Apr 2024 22:53:46 +0200 Subject: [PATCH] feat: reorder chapters (#71) * fix: reorder chapter on README * fix: delete resources from sidebar * fix: reorder chapters on sidebar * feat: add sumarize for each chapter on the README * fix: create a tip to read chapters in order --- README.md | 32 +++++++++++++++++++++++++++----- _layouts/sidebar.md | 8 ++++---- 2 files changed, 31 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f14a2a0..2108a9e 100644 --- a/README.md +++ b/README.md @@ -14,23 +14,43 @@ The course is divided into chapters, with each covering a different aspect of be ### [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) -### [Building and Nurturing a Welcoming and Supportive Community](building-community.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. -### [How to Communicate and Collaborate Effectively](communication-and-collaboration.md) +### [The Power of Metrics and Analytics](metrics-and-analytics.md) -### [How to Maintain Code Quality and Documentation](maintaining-code-quality.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) -### [The Power of Metrics and Analytics](metrics-and-analytics.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 @@ -41,7 +61,9 @@ As this is the beginning of your open source maintainer journey, we've also prov ## 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! + +?> **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. diff --git a/_layouts/sidebar.md b/_layouts/sidebar.md index 7ee56d8..8ec4bed 100644 --- a/_layouts/sidebar.md +++ b/_layouts/sidebar.md @@ -2,12 +2,12 @@ - [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) + - [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)