Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Correct broken "Edit the Page" link in documentation #246

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .docusaurus/DONT-EDIT-THIS-FOLDER
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
This folder stores temp files that Docusaurus' client bundler accesses.

DO NOT hand-modify files in this folder because they will be overwritten in the
next build. You can clear all build artifacts (including this folder) with the
`docusaurus clear` command.
6 changes: 6 additions & 0 deletions .docusaurus/client-modules.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export default [
require("E:\\Projects\\PR\\OpenSauced Intro\\OpenSauced-fix-BrokenLink\\OpenSauced-Fix\\node_modules\\infima\\dist\\css\\default\\default.css"),
require("E:\\Projects\\PR\\OpenSauced Intro\\OpenSauced-fix-BrokenLink\\OpenSauced-Fix\\node_modules\\@docusaurus\\theme-classic\\lib\\prism-include-languages"),
require("E:\\Projects\\PR\\OpenSauced Intro\\OpenSauced-fix-BrokenLink\\OpenSauced-Fix\\node_modules\\@docusaurus\\theme-classic\\lib\\nprogress"),
require("E:\\Projects\\PR\\OpenSauced Intro\\OpenSauced-fix-BrokenLink\\OpenSauced-Fix\\src\\css\\custom.css"),
];
1 change: 1 addition & 0 deletions .docusaurus/codeTranslations.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"name": "docusaurus-plugin-content-blog",
"id": "default"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"title": "Recent posts",
"items": []
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"blogBasePath": "/learn/blog",
"blogTitle": "Blog"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"name": "docusaurus-plugin-content-docs",
"id": "default"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"introToOSS":[{"type":"category","label":"Intro to Open Source","items":[{"type":"link","label":"Intro to Open Source","href":"/learn/intro-to-oss/","docId":"intro-to-oss/Contributor-README","unlisted":false},{"type":"link","label":"What is Open Source","href":"/learn/intro-to-oss/what-is-open-source","docId":"intro-to-oss/what-is-open-source","unlisted":false},{"type":"link","label":"Why Open Source","href":"/learn/intro-to-oss/why-open-source","docId":"intro-to-oss/why-open-source","unlisted":false},{"type":"link","label":"Tools to be Successful","href":"/learn/intro-to-oss/tools-to-be-successful","docId":"intro-to-oss/tools-to-be-successful","unlisted":false},{"type":"link","label":"How to Contribute to Open Source","href":"/learn/intro-to-oss/how-to-contribute-to-open-source","docId":"intro-to-oss/how-to-contribute-to-open-source","unlisted":false},{"type":"link","label":"The Secret Sauce","href":"/learn/intro-to-oss/the-secret-sauce","docId":"intro-to-oss/the-secret-sauce","unlisted":false},{"type":"link","label":"Types of Contributions","href":"/learn/intro-to-oss/types-of-contributions","docId":"intro-to-oss/types-of-contributions","unlisted":false},{"type":"link","label":"Conclusion","href":"/learn/intro-to-oss/conclusion","docId":"intro-to-oss/conclusion","unlisted":false},{"type":"link","label":"Additional Resources","href":"/learn/intro-to-oss/additional-resources","docId":"intro-to-oss/additional-resources","unlisted":false},{"type":"link","label":"Glossary","href":"/learn/intro-to-oss/glossary","docId":"intro-to-oss/glossary","unlisted":false}],"collapsed":true,"collapsible":true}],"becomingAMaintainer":[{"type":"category","label":"Becoming a Maintainer","items":[{"type":"link","label":"Becoming a Maintainer","href":"/learn/becoming-a-maintainer/","docId":"becoming-a-maintainer/Maintainer-README","unlisted":false},{"type":"link","label":"Understanding Maintainership","href":"/learn/becoming-a-maintainer/intro","docId":"becoming-a-maintainer/intro","unlisted":false},{"type":"link","label":"How to Set Up Your Project","href":"/learn/becoming-a-maintainer/how-to-setup-your-project","docId":"becoming-a-maintainer/how-to-setup-your-project","unlisted":false},{"type":"link","label":"Managing Issues and Pull Requests","href":"/learn/becoming-a-maintainer/issues-and-pull-requests","docId":"becoming-a-maintainer/issues-and-pull-requests","unlisted":false},{"type":"link","label":"Effective Communication and Collaboration","href":"/learn/becoming-a-maintainer/communication-and-collaboration","docId":"becoming-a-maintainer/communication-and-collaboration","unlisted":false},{"type":"link","label":"Maintaining Code Quality and Documentation","href":"/learn/becoming-a-maintainer/maintaining-code-quality","docId":"becoming-a-maintainer/maintaining-code-quality","unlisted":false},{"type":"link","label":"Building and Nurturing Community","href":"/learn/becoming-a-maintainer/building-community","docId":"becoming-a-maintainer/building-community","unlisted":false},{"type":"link","label":"Maintainer Powerups","href":"/learn/becoming-a-maintainer/maintainer-powerups","docId":"becoming-a-maintainer/maintainer-powerups","unlisted":false},{"type":"link","label":"Building Your Team","href":"/learn/becoming-a-maintainer/your-team","docId":"becoming-a-maintainer/your-team","unlisted":false},{"type":"link","label":"The Power of Metrics and Analytics","href":"/learn/becoming-a-maintainer/metrics-and-analytics","docId":"becoming-a-maintainer/metrics-and-analytics","unlisted":false},{"type":"link","label":"Getting Practical","href":"/learn/becoming-a-maintainer/getting-practical","docId":"becoming-a-maintainer/getting-practical","unlisted":false},{"type":"link","label":"Maintainers Guestbook","href":"/learn/becoming-a-maintainer/maintainers-guestbook","docId":"becoming-a-maintainer/maintainers-guestbook","unlisted":false},{"type":"link","label":"Additional Resources","href":"/learn/becoming-a-maintainer/additional-resources","docId":"becoming-a-maintainer/additional-resources","unlisted":false},{"type":"link","label":"Glossary","href":"/learn/becoming-a-maintainer/glossary","docId":"becoming-a-maintainer/glossary","unlisted":false}],"collapsed":true,"collapsible":true}]},"docs":{"becoming-a-maintainer/additional-resources":{"id":"becoming-a-maintainer/additional-resources","title":"Additional Resources","description":"On this page, you will find additional resources to help you learn more about all things around open source maintainers.","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/building-community":{"id":"becoming-a-maintainer/building-community","title":"Building and Nurturing a Welcoming and Supportive Community","description":"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.","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/communication-and-collaboration":{"id":"becoming-a-maintainer/communication-and-collaboration","title":"How to Communicate and Collaborate Effectively","description":"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.","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/community-translations":{"id":"becoming-a-maintainer/community-translations","title":"Community Course Translations","description":"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."},"becoming-a-maintainer/getting-practical":{"id":"becoming-a-maintainer/getting-practical","title":"Let's Get Practical: Starting Your Project","description":"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!","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/glossary":{"id":"becoming-a-maintainer/glossary","title":"Glossary","description":"API Documentation","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/how-to-setup-your-project":{"id":"becoming-a-maintainer/how-to-setup-your-project","title":"How to Setup Your Open Source Project","description":"There are many things to consider when you think about how to start an open source project. In this portion of the course, we will walk through the key components every project needs to succeed.","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/intro":{"id":"becoming-a-maintainer/intro","title":"Understanding the Role of an Open Source Maintainer","description":"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.","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/issues-and-pull-requests":{"id":"becoming-a-maintainer/issues-and-pull-requests","title":"How to Handle Open Issues and Pull Requests","description":"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.","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/maintainer-powerups":{"id":"becoming-a-maintainer/maintainer-powerups","title":"Maintainer Power Ups","description":"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.","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/Maintainer-README":{"id":"becoming-a-maintainer/Maintainer-README","title":"Becoming a Maintainer with OpenSauced","description":"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.","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/maintainers-guestbook":{"id":"becoming-a-maintainer/maintainers-guestbook","title":"Maintainers Guestbook","description":"Congratulations on finishing the Becoming a Maintainer Course with OpenSauced. Welcome to our Maintainers Guestbook, where you can share your first project with us!","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/maintaining-code-quality":{"id":"becoming-a-maintainer/maintaining-code-quality","title":"How to Maintain Code Quality and Documentation","description":"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.","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/metrics-and-analytics":{"id":"becoming-a-maintainer/metrics-and-analytics","title":"The Power of Open Source Metrics and Analytics for New Maintainers","description":"Understanding what's happening with your project and contributors as it grows can be challenging for new maintainers. Think of open source 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.","sidebar":"becomingAMaintainer"},"becoming-a-maintainer/your-team":{"id":"becoming-a-maintainer/your-team","title":"Building Your Open Source Dream Team","description":"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.","sidebar":"becomingAMaintainer"},"intro-to-oss/additional-resources":{"id":"intro-to-oss/additional-resources","title":"Additional Resources","description":"On this page, you can find resources to help you learn further about contributing to open source:","sidebar":"introToOSS"},"intro-to-oss/conclusion":{"id":"intro-to-oss/conclusion","title":"Conclusion","description":"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.","sidebar":"introToOSS"},"intro-to-oss/Contributor-README":{"id":"intro-to-oss/Contributor-README","title":"Intro to Open Source with OpenSauced","description":"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.","sidebar":"introToOSS"},"intro-to-oss/glossary":{"id":"intro-to-oss/glossary","title":"Glossary","description":"Branch","sidebar":"introToOSS"},"intro-to-oss/how-to-contribute-to-open-source":{"id":"intro-to-oss/how-to-contribute-to-open-source","title":"How to Contribute to Open Source","description":"In this chapter, we'll guide you through the process of how to contribute to open source.","sidebar":"introToOSS"},"intro-to-oss/the-secret-sauce":{"id":"intro-to-oss/the-secret-sauce","title":"The Secret Sauce","description":"In this chapter, we'll share some lesser-known strategies and tips for making a lasting impact in the open source community. We'll discuss how to focus on open issues, gain traction in your contributions, and develop your open source resume using OpenSauced.","sidebar":"introToOSS"},"intro-to-oss/tools-to-be-successful":{"id":"intro-to-oss/tools-to-be-successful","title":"Tools to be Successful","description":"To be successful in your open source journey, it's essential to familiarize yourself with the tools and platforms commonly used by the community. These tools will help you collaborate effectively, manage your projects, and contribute to open source projects. In this chapter, we'll discuss the following essential tools for open source collaboration:","sidebar":"introToOSS"},"intro-to-oss/types-of-contributions":{"id":"intro-to-oss/types-of-contributions","title":"Types of Open Source Contributions","description":"Contributions to open source projects can take many forms, such as coding, documentation, testing, and more. It is important to note that open source contributions are not limited to developers only. Anyone can contribute to open source projects, regardless of their technical skills.","sidebar":"introToOSS"},"intro-to-oss/what-is-open-source":{"id":"intro-to-oss/what-is-open-source","title":"What is Open Source?","description":"In this chapter, we'll explore the history of open source and what that means. Before contributing to a project, you should understand what is open source and the principles behind it to help you appreciate the context in which you'll be collaborating and contributing.","sidebar":"introToOSS"},"intro-to-oss/why-open-source":{"id":"intro-to-oss/why-open-source","title":"Why Open Source?","description":"In the previous chapter, we explored the concept of open source and its history. Now, let's look at the many benefits of open source software contributions. By understanding the advantages of open source collaboration, you'll be better equipped to leverage the opportunities it presents and make the most of your open source journey.","sidebar":"introToOSS"}}}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"id": "becoming-a-maintainer/additional-resources",
"title": "Additional Resources",
"description": "On this page, you will find additional resources to help you learn more about all things around open source maintainers.",
"source": "@site/docs/becoming-a-maintainer/additional-resources.md",
"sourceDirName": "becoming-a-maintainer",
"slug": "/becoming-a-maintainer/additional-resources",
"permalink": "/learn/becoming-a-maintainer/additional-resources",
"draft": false,
"unlisted": false,
"editUrl": "https://github.com/open-sauced/intro/docs/becoming-a-maintainer/additional-resources.md",
"tags": [],
"version": "current",
"frontMatter": {
"id": "additional-resources",
"title": "Additional Resources",
"sidebar_label": "Additional Resources",
"keywords": [
"additional resources for open source maintainers",
"guides resources for open source maintainers",
"blog posts resources for open source maintainers",
"open source maintainers",
"Open Source",
"Open Source Community"
]
},
"sidebar": "becomingAMaintainer",
"previous": {
"title": "Maintainers Guestbook",
"permalink": "/learn/becoming-a-maintainer/maintainers-guestbook"
},
"next": {
"title": "Glossary",
"permalink": "/learn/becoming-a-maintainer/glossary"
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"id": "becoming-a-maintainer/building-community",
"title": "Building and Nurturing a Welcoming and Supportive Community",
"description": "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.",
"source": "@site/docs/becoming-a-maintainer/building-community.md",
"sourceDirName": "becoming-a-maintainer",
"slug": "/becoming-a-maintainer/building-community",
"permalink": "/learn/becoming-a-maintainer/building-community",
"draft": false,
"unlisted": false,
"editUrl": "https://github.com/open-sauced/intro/docs/becoming-a-maintainer/building-community.md",
"tags": [],
"version": "current",
"frontMatter": {
"id": "building-community",
"title": "Building and Nurturing a Welcoming and Supportive Community",
"sidebar_label": "Building and Nurturing Community",
"keywords": [
"building community",
"building open source community",
"nurturing community",
"nurturing open source community",
"welcoming and supportive community",
"positive community culture",
"how to build and nurture community",
"best practices in building and nurturing community",
"fostering community",
"fostering open source community",
"open source maintainer",
"Open Source",
"Open Source Community"
]
},
"sidebar": "becomingAMaintainer",
"previous": {
"title": "Maintaining Code Quality and Documentation",
"permalink": "/learn/becoming-a-maintainer/maintaining-code-quality"
},
"next": {
"title": "Maintainer Powerups",
"permalink": "/learn/becoming-a-maintainer/maintainer-powerups"
}
}
Loading
Loading