open-sauced · BekahHW · Jun 12, 2024 · Jun 11, 2024 · Jun 11, 2024 · Jun 11, 2024
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
@@ -1,11 +1,9 @@
-<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>
-
+---
+id: Maintainer-README
+title: "Becoming a Maintainer with OpenSauced"
+sidebar_label: "Becoming a Maintainer"
+keywords: ["README", "Open Source", "Open Source Community"]
+---
 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

@@ -1,3 +1,10 @@
+---
+id: _navbar
+title: "_navbar"
+sidebar_label: "_navbar"
+keywords: ["_navbar", "Open Source", "Open Source Community"]
+---
+
 - [Homepage](../README.md)
 - Courses
   - [Intro to Open Source](/intro-to-oss/README.md)

@@ -1,3 +1,10 @@
+---
+id: _sidebar
+title: "_sidebar"
+sidebar_label: "_sidebar"
+keywords: ["_sidebar", "Open Source", "Open Source Community"]
+---
+
 [![OpenSauced Logo](../_assets/images/logo-on-dark.png)](https://opensauced.pizza/)
 
 - **Chapters**

@@ -1,3 +1,10 @@
+---
+id: additional-resources
+title: "additional resources"
+sidebar_label: "additional resources"
+keywords: ["additional resources", "Open Source", "Open Source Community"]
+---
+
 # Additional Resources
 
 On this page, you will find additional resources to help you learn more about all things around open source maintainers.

@@ -1,3 +1,10 @@
+---
+id: building-community
+title: "building community"
+sidebar_label: "building community"
+keywords: ["building community", "Open Source", "Open Source Community"]
+---
+
 # Building and Nurturing a Welcoming and Supportive Community
 
 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.

@@ -1,3 +1,10 @@
+---
+id: communication-and-collaboration
+title: "communication and collaboration"
+sidebar_label: "communication and collaboration"
+keywords: ["communication and collaboration", "Open Source", "Open Source Community"]
+---
+
 # How to Communicate and Collaborate Effectively
 
 Effective communication and collaboration with contributors are the keys to a thriving open source community. As maintainers, you want to smoothly onboard new contributors to your projects and build a welcoming community with open lines of communication between contributors and maintainers.
@@ -136,11 +143,11 @@ Here are some ways to create boundaries:
 
   You need to know that it's okay to take time off, step away from your project, and take care of yourself. You can inform your contributors that you will review their pull requests after you return. Here is an example of what you can say:
 
-  > "Hey {username}, thank you for your PR. I will take two weeks off starting tomorrow and review this upon my return. You may ask about the status of your PR if I haven't responded to it in the next three weeks."
+  > "Hey \{username}, thank you for your PR. I will take two weeks off starting tomorrow and review this upon my return. You may ask about the status of your PR if I haven't responded to it in the next three weeks."
 
   When pull requests come during your days off, after you return, you can thank and let the contributors know you will review the pull requests. Consider to say something like this:
 
-  > "Hey {username}, I just returned from my days off. Thank you for taking this on! I need time to review it and will get back to you soon. I appreciate your patience."
+  > "Hey \{username}, I just returned from my days off. Thank you for taking this on! I need time to review it and will get back to you soon. I appreciate your patience."
 
 - **No private or direct message**
 
@@ -200,7 +207,7 @@ Instead of saying:
 
 You can say something like:
 
-> "Thank you for your prompt work on the PRs, {username}. I really appreciate it! However, let's focus more on quality than quantity. I noticed a few things that I believe could further improve the quality of your work:
+> "Thank you for your prompt work on the PRs, \{username}. I really appreciate it! However, let's focus more on quality than quantity. I noticed a few things that I believe could further improve the quality of your work:
 >
 > - It might be a good idea to take time to fully understand the issue before starting work on a PR, as this solution is different from what we asked in the issue. If you need help or clarification, don't hesitate to reach out.
 > - Another thing that could be helpful is running and testing the code locally before submitting a PR. This way, you'll be able to ensure that the code runs as it should. It can save you time from going back and forth on revisions.

@@ -1,3 +1,10 @@
+---
+id: community-translations
+title: "community translations"
+sidebar_label: "community translations"
+keywords: ["community translations", "Open Source", "Open Source Community"]
+---
+
 # Community Course Translations
 
 We are grateful for the contributions of the community in translating our courses. Although the OpenSauced team does not currently maintain these projects, we want to share the forked copy of the repositories with those taking the course. Below, you will find the latest community translations.

@@ -1,3 +1,10 @@
+---
+id: getting-practical
+title: "getting practical"
+sidebar_label: "getting practical"
+keywords: ["getting practical", "Open Source", "Open Source Community"]
+---
+
 # Let's Get Practical: Starting Your Project
 
 Now that you've gone through the course and understand what it takes to be a successful maintainer, let's get practical and start your first open source project as a maintainer!

@@ -1,3 +1,10 @@
+---
+id: glossary
+title: "glossary"
+sidebar_label: "glossary"
+keywords: ["glossary", "Open Source", "Open Source Community"]
+---
+
 ## API Documentation
 
 API documentation is a technical document that explains how to use and work with an API. This manual contains all the information required to work with the API including details on how to make requests, what data formats are supported, and what response codes are returned.

@@ -1,3 +1,10 @@
+---
+id: how-to-setup-your-project
+title: "how to setup your project"
+sidebar_label: "how to setup your project"
+keywords: ["how to setup your project", "Open Source", "Open Source Community"]
+---
+
 # How to Setup Your Open Source Project
 
 There are many things to consider when setting up your open source project. In this portion of the course, we will walk through the key components every project needs to succeed.

@@ -1,3 +1,10 @@
+---
+id: intro
+title: "intro"
+sidebar_label: "intro"
+keywords: ["intro", "Open Source", "Open Source Community"]
+---
+
 # Understanding the Role of an Open Source Maintainer
 
 Being an open source maintainer can be a very gratifying and rewarding experience. But a lot of work goes into maintaining an open source project. You will have many responsibilities as a maintainer, including being a contributor, leader, mentor, and community manager.

@@ -1,3 +1,10 @@
+---
+id: issues-and-pull-requests
+title: "issues and pull requests"
+sidebar_label: "issues and pull requests"
+keywords: ["issues and pull requests", "Open Source", "Open Source Community"]
+---
+
 # How to Handle Open Issues and Pull Requests
 
 One of the core responsibilities of an open source maintainer is triaging open issues and reviewing pull requests. In this chapter, we will talk about how to handle best open issues, pull requests, and security vulnerabilities.

@@ -1,3 +1,10 @@
+---
+id: maintainer-powerups
+title: "maintainer powerups"
+sidebar_label: "maintainer powerups"
+keywords: ["maintainer powerups", "Open Source", "Open Source Community"]
+---
+
 # Maintainer Power Ups
 
 Maintainers have a variety of daily tasks. You often juggle triaging new issues, reviewing pull requests, testing changes, and managing and moderating the community, such as welcoming new contributors and thanking contributors for their contributions. Most of the time, you are expected to respond to these tasks promptly. Sometimes, these never-ending tasks take too much time and are overwhelming. It would help if you were efficient in what you do.

@@ -1,3 +1,10 @@
+---
+id: maintainers-guestbook
+title: "maintainers guestbook"
+sidebar_label: "maintainers guestbook"
+keywords: ["maintainers guestbook", "Open Source", "Open Source Community"]
+---
+
 # 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!

@@ -1,3 +1,10 @@
+---
+id: maintaining-code-quality
+title: "maintaining code quality"
+sidebar_label: "maintaining code quality"
+keywords: ["maintaining code quality", "Open Source", "Open Source Community"]
+---
+
 # How to Maintain Code Quality and Documentation
 
 Maintaining a project with high code quality and up-to-date documentation is important. This will help contributors understand the project and make it easier for them to contribute.

@@ -1,3 +1,10 @@
+---
+id: metrics-and-analytics
+title: "metrics and analytics"
+sidebar_label: "metrics and analytics"
+keywords: ["metrics and analytics", "Open Source", "Open Source Community"]
+---
+
 # The Power of Metrics and Analytics for New Maintainers
 
 Understanding what's happening with your project and contributors as it grows can be challenging for new maintainers. Think of metrics and analytics like a compass and map in your maintainer journey. Understanding metrics for open source projects and your own project can help you to set goals, identify project needs, and understand your community. This chapter will guide you through understanding, leveraging, and making decisions based on these insights to create a thriving open source project.

@@ -1,3 +1,10 @@
+---
+id: your-team
+title: "your team"
+sidebar_label: "your team"
+keywords: ["your team", "Open Source", "Open Source Community"]
+---
+
 # Building Your Open Source Dream Team
 
 Managing an open source project requires clear communication, empathy, and technical understanding. You might find that initially, you can do all or most of the work by yourself. That's great! If you want your project to grow and thrive, cultivating a diverse, motivated, and effective team around you can help you do that. This chapter looks at how to collaborate with your team effectively and offers guidance on identifying, onboarding, and empowering your open source squad.

diff --git a/docs/README.md → docs/intro-to-oss/README 2.md b/docs/README.md → docs/intro-to-oss/README 2.md
@@ -1,3 +1,10 @@
+---
+id: README 2
+title: "README 2"
+sidebar_label: "README 2"
+keywords: ["README 2", "Open Source", "Open Source Community"]
+---
+
 <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

@@ -1,20 +1,12 @@
-<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;">Intro to Open Source with <span style="background: linear-gradient(to right, #e74c3c, #e67e22); -webkit-background-clip: text; color: transparent;"> OpenSauced
-        </span></h1>
-    </div>
-</div>
+---
+id: Contributor-README
+title: "Intro to Open Source with OpenSauced"
+sidebar_label: "Intro to Open Source"
+keywords: ["README", "Open Source", "Open Source Community"]
+---
 
 Welcome to the Intro to Open Source Course with OpenSauced! This course is designed to provide you with an introduction to open source and guide you through the process of contributing to open source projects.
 
-## Language Support
-
-Like pizza, open source is meant to be shared with everyone. We provide and maintain translations in languages below as our official translations:
-
-- [French](./translations/fr/README.md)
-
-For translations in other languages that are maintained by our community, please go to the [Community Translations](../community-translations.md) section.
-
 ## Course Overview
 
 The course is divided into chapters, each covering a different aspect of open source:

@@ -1,8 +1,12 @@
+---
+id: _navbar
+title: "_navbar"
+sidebar_label: "_navbar"
+keywords: ["_navbar", "Open Source", "Open Source Community"]
+---
+
 - [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)
-- Languages
-  - [:us: English](/intro-to-oss/)
-  - [:fr: French](/intro-to-oss/translations/fr/)
@@ -1,3 +1,10 @@
+---
+id: _sidebar
+title: "_sidebar"
+sidebar_label: "_sidebar"
+keywords: ["_sidebar", "Open Source", "Open Source Community"]
+---
+
 [![OpenSauced Logo](../_assets/images/logo-on-dark.png)](https://opensauced.pizza/)
 
 - Intro to Open Source

@@ -1,3 +1,10 @@
+---
+id: additional-resources
+title: "additional resources"
+sidebar_label: "additional resources"
+keywords: ["additional resources", "Open Source", "Open Source Community"]
+---
+
 # Additional Resources
 
 On this page, you can find resources to help you learn further about contributing to open source:

@@ -1,3 +1,10 @@
+---
+id: conclusion
+title: "conclusion"
+sidebar_label: "conclusion"
+keywords: ["conclusion", "Open Source", "Open Source Community"]
+---
+
 # Conclusion
 
 As we wrap up this course on getting started with open source, let's recap the key takeaways and discuss what's next in your open source journey.

@@ -1,3 +1,10 @@
+---
+id: glossary
+title: "glossary"
+sidebar_label: "glossary"
+keywords: ["glossary", "Open Source", "Open Source Community"]
+---
+
 ## Branch
 
 A branch is a separate version of the code that's created for development purposes. Branches allow contributors to experiment with changes without affecting the main codebase. When changes are ready to be merged into the main codebase, they're typically submitted as a pull request.
@@ -70,6 +77,4 @@ A repository is a central location where code is stored and managed. In open sou
 
 A style guide is a set of rules and conventions that define the preferred formatting, writing style, and visual elements used in documentation and other content. This helps maintain consistency and clarity across documents, making them easier to read and understand.
 
-<footer>
-  <a href="https://github.com/open-sauced/intro/blob/main/docs/intro-to-oss/glossary.md">✏️ Edit this page</a>
-</footer>
+