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

test: two courses in one site #60

Closed
wants to merge 12 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
9 changes: 0 additions & 9 deletions _layouts/sidebar.md

This file was deleted.

20 changes: 19 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
# maintainer-intro-course
<div align="center">
<br>
<img alt="Open Sauced" src="https://i.ibb.co/7jPXt0Z/logo1-92f1a87f.png" width="300px">
<h1 id="intro-oss">πŸ• Open Source Education Path with OpenSauced πŸ•</h1>
<strong>The site provides course materials for "Intro to Open Source" and "Becoming Maintainer" with OpenSauced.</strong>
</div>

<br>

Welcome to the OpenSauced Education path!

## Our Mission

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Sit amet mattis vulputate enim nulla. Ipsum nunc aliquet bibendum enim facilisis gravida neque convallis a. Risus pretium quam vulputate dignissim suspendisse. Vel orci porta non pulvinar. Tincidunt arcu non sodales neque sodales. Tincidunt tortor aliquam nulla facilisi cras fermentum odio eu feugiat. Eget arcu dictum varius duis at. Rhoncus mattis rhoncus urna neque viverra justo nec ultrices dui. Senectus et netus et malesuada fames. Morbi blandit cursus risus at. Id ornare arcu odio ut sem nulla pharetra diam sit. Mi tempus imperdiet nulla malesuada. Ligula ullamcorper malesuada proin libero nunc consequat interdum varius sit.

## Our Courses

- [Intro to OSS](./intro-oss/)
- [Becoming Maintainer](./becoming-maintainer/)
6 changes: 6 additions & 0 deletions docs/_coverpage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Welcome to the OpenSauced Education path!

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Sit amet mattis vulputate enim nulla. Ipsum nunc aliquet bibendum enim facilisis gravida neque convallis a. Risus pretium quam vulputate dignissim suspendisse. Vel orci porta non pulvinar. Tincidunt arcu non sodales neque sodales. Tincidunt tortor aliquam nulla facilisi cras fermentum odio eu feugiat. Eget arcu dictum varius duis at. Rhoncus mattis rhoncus urna neque viverra justo nec ultrices dui. Senectus et netus et malesuada fames. Morbi blandit cursus risus at. Id ornare arcu odio ut sem nulla pharetra diam sit. Mi tempus imperdiet nulla malesuada. Ligula ullamcorper malesuada proin libero nunc consequat interdum varius sit.

[Intro to OSS](./intro-oss/)
[Becoming Maintainer](./becoming-maintainer/)
1 change: 1 addition & 0 deletions docs/_navbar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- [Homepage](/)
1 change: 1 addition & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- [Homepage](/)
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to OpenSauced Intro
# Contributing to Becoming Maintainer with OpenSauced

Contributions are always welcome, no matter how large or small. Before contributing, please read the [Code of Conduct](https://docs.opensauced.pizza/contributing/code-of-conduct/) and follow the directions in this guide.

Expand Down Expand Up @@ -271,4 +271,4 @@ git pull

## Translating the Maintainer Intro Course

Translating our Maintainer Intro 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 Maintainer Intro 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.
8 changes: 4 additions & 4 deletions README.md β†’ docs/becoming-maintainer/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="center">
<br>
<img alt="Open Sauced" src="https://i.ibb.co/7jPXt0Z/logo1-92f1a87f.png" width="300px">
<h1>πŸ• Becoming a Maintainer with OpenSauced πŸ•</h1>
<h1 id="becoming-maintainer">πŸ• Becoming a Maintainer with OpenSauced πŸ•</h1>
<strong>The site provides course materials for OpenSauced's Becoming a Maintainer Course.</strong>
</div>
<br>
Expand All @@ -12,7 +12,7 @@ Welcome to the Becoming a Maintainer Course with OpenSauced! This course is desi

The course is divided into X chapters, 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](/becoming-maintainer/intro.md)

### [Chapter X: Setting Up Your Project](/how-to-setup-your-project.md)

Expand Down Expand Up @@ -56,9 +56,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
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
- [Home Page](/)
- [Homepage](/)
- [⭐ Star The Repo](https://github.com/open-sauced/maintainer-intro-course)
10 changes: 10 additions & 0 deletions docs/becoming-maintainer/_sidebar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
- Becoming Maintainer Course

- [Open Source Maintainer](/becoming-maintainer/intro.md)
- [Setting Up Your Project](/becoming-maintainer/how-to-setup-your-project.md)
- [Issues and Pull Requests](/becoming-maintainer/issues-and-pull-requests.md)
- [Maintainer Power Ups](/becoming-maintainer/maintainer-powerups.md)
- [Setting Up Your Team](/becoming-maintainer/your-team.md)
- [Building and Nurturing Community](/becoming-maintainer/building-community.md)
- [Effective Communication and Collaboration](/becoming-maintainer/communication-and-collaboration.md)
- [Maintaining Code Quality and Documentation](/becoming-maintainer/maintaining-code-quality.md)
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -87,14 +87,6 @@ Using the GitHub CLI will save you time and boost your productivity as a maintai

Head over to the [GitHub CLI repository](https://github.com/cli/cli#installation) for information on installing GitHub CLI on your machine, and read this [blog post](https://dev.to/opensauced/boost-productivity-with-the-github-cli-2mne) to get you started.

## Issues and Pull Request Templates

Have you ever found yourself in a situation where you're reviewing pull requests or triaging issues, but you can't understand what's happening because contributors didn't provide sufficient information? Or, have you had to close an issue or pull request because the description, screenshot, or other crucial information was missing?

The good news is that you can address these problems by creating issue and pull request templates. These templates allow you to customize and standardize it to include necessary information. You can see them as guides for contributors to follow when writing an issue or pull request for your project. By creating templates, you can save time on triaging issues, reviewing pull requests, and ensuring you get all the information you need from your contributors. Additionally, future contributors can benefit from these templates by understanding the history of changes made, which can help them debug or understand the code involved.

You can learn more about [configuring issue templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository) and [creating a pull request template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository) on the official GitHub documentation.

## Saved Replies

Sometimes, you repeatedly write the same reply to issues or pull requests. It's crucial to keep clear communication between maintainers and contributors. So, when you write all comments manually, your message will no longer be consistent, and they may be unclear. You can create saved replies when you frequently respond to issues and pull requests with the same comments.
Expand Down
94 changes: 94 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<!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"
/>
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link rel="stylesheet" href="./styles/custom.css" />
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
name: "",
repo: "",
themeColor: "#ED6A32",
// comment out below lines to see coverpage
// coverpage: true,
// onlyCover: true,
loadSidebar: true,
loadNavbar: true,
alias: {
// courses sidebar
"/.*/intro-oss/_sidebar.md": "/intro-oss/_sidebar.md",
"/.*/becoming-maintainer/_sidebar.md":
"/becoming-maintainer/_sidebar.md",
// courses navbar
"/.*/intro-oss/_navbar.md": "/intro-oss/_navbar.md",
"/.*/becoming-maintainer/_navbar.md":
"/becoming-maintainer/_navbar.md",
},
relativePath: true,
subMaxLevel: 3,
search: "auto",
search: {
maxAge: 86400000,
paths: "auto",
placeholder: "Search",
noData: "No Results found!",
depth: 6,
hideOtherSidebarContent: false,
},
darklightTheme: {
siteFont: "Inter",
bodyFontSize: "16px",
dark: {
background: "#11181C",
textColor: "#FFFDFA",
accent: "#ED6A32",
highlightColor: "#ED6A32",
codeBackgroundColor: "#050505",
borderColor: "#ED6A32",
sidebarSublink: "#ED6A32",
blockQuoteColor: "#FFE4AD",
coverBackground: "#11181C",
},
light: {
background: "#FFFDFA",
accent: "#BD430F",
highlightColor: "#BD430F",
borderColor: "#BD430F",
sidebarSublink: "#BD430F",
codeBackgroundColor: "#F2F2F2",
blockQuoteColor: "#3B555E",
coverBackground: "#FFFDFA",
},
},
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="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
<script
src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js"
type="text/javascript"
></script>
</body>
</html>
61 changes: 61 additions & 0 deletions docs/intro-oss/01-intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Introduction

Welcome to the "Intro to Open Source with OpenSauced" course! This comprehensive course will guide you through the fascinating world of open source and help you become an active contributor. By the end of this course, you should have a solid understanding of how to find, join, and contribute to open source projects, as well as how to develop your open source resume. But first, let's set the stage by discussing the prerequisites, objectives, and expectations for this course.

## Prerequisites

Before diving into the world of open source, it's essential to have a basic understanding of programming concepts and some experience working with code. While the course will provide examples and demos, you'll get the most out of the material if you have some prior knowledge.

Additionally, this course assumes that you are familiar with Git and GitHub. Git is a widely-used version control system, and GitHub is a popular platform for hosting and collaborating on Git repositories. If you're not already familiar with Git and GitHub, we recommend taking some time to learn the basics before starting this course.

## Objectives

Throughout this course, our primary objectives are to help you:

1. **Understand open source and its benefits**: We'll explore the concept of open source, its history, and the numerous advantages of contributing to open source projects.
2. **Learn how to find open source projects**: Discovering projects that align with your interests and skills is crucial for a rewarding open source experience. We'll introduce you to tools and techniques for finding projects to contribute to.
3. **Master the tools and processes for contributing**: We'll provide an overview of the essential tools and processes required for successful open source collaboration, such as version control, code review, and communication platforms.
4. **Gain practical experience**: By following along with examples and demos, you'll have the opportunity to practice your skills and gain confidence in your ability to contribute to open source projects.
5. **Develop your open source resume**: Showcasing your open source contributions is vital for building your reputation in the community and demonstrating your expertise to potential employers or clients. We'll discuss strategies for developing and maintaining your open source resume.

## Expectations

This course is designed to provide you with a solid foundation in open source collaboration. While we'll cover a range of topics and provide examples, demos, and opportunities for hands-on practice, it's essential to have realistic expectations about what you can achieve during the course.

1. **Practice is crucial**: Learning about open source is just the beginning; to truly develop your skills and become a proficient contributor, you'll need to practice consistently. Keep in mind that the more you contribute to open source projects, the more you'll learn and grow as a developer.

2. **Patience is key**: Becoming proficient in open source collaboration takes time and effort. Don't be discouraged if you encounter challenges along the way; remember that every contribution, no matter how small, is valuable and helps improve the project.

3. **Engagement with the community**: Open source is more than just code; it's about the people who collaborate and contribute to projects. Engage with the community by asking questions, sharing your knowledge, and supporting others. Building relationships with other contributors will enhance your open source experience and help you grow as a developer.

4. **Continuous learning**: Open source is a rapidly evolving field, with new projects, tools, and technologies emerging all the time. Stay curious and open to learning, and take advantage of resources like documentation, tutorials, and community forums to expand your knowledge and stay up-to-date with the latest developments.

5. **Developing a growth mindset**: Embrace the challenges and opportunities that come with open source collaboration. Adopt a growth mindset, which focuses on learning, improvement, and resilience. By viewing obstacles as opportunities for growth, you'll be better equipped to navigate the complex world of open source and achieve success in your contributions.

## Course Structure

This course is divided into several chapters, each designed to cover a specific aspect of open source collaboration:

1. **Intro:** We'll begin by setting the stage for your open source journey, discussing prerequisites, objectives, and expectations.
1. **What is Open Source?:** In this chapter, we'll explore the definition of open source and its history, providing you with a solid foundation for understanding the context of open source collaboration.
1. **Why Open Source?:** We'll delve into the benefits of open source, including access to knowledge, community, and skills development.
1. **Tools to be successful:** This chapter will introduce you to the essential tools for successful open source collaboration, including GitHub, Git, CodeSee, VS Code, and Discord.
1. **How to Contribute to Open Source:** In this chapter, we'll discuss the process of finding projects to work on, submitting contributions, onboarding in a new project, and what to expect after your contribution has been submitted.
1. **The Secret Sauce:** This chapter will reveal the strategies and techniques for getting started, gaining traction in your contributions, and developing your open source resume.
1. **Conclusion:** We'll wrap up the course with key takeaways and discuss the next steps in your open source journey.

Throughout this course, we'll provide examples and demos to help illustrate key concepts and provide hands-on opportunities for practice. When possible, we'll feature real-world open source projects and tools, such as [OpenSauced](https://opensauced.pizza/), to demonstrate how to apply the skills you've learned.

Please note that while these examples and demos are designed to provide guidance and inspiration, your own open source journey may differ depending on your interests, skills, and chosen projects.

Use the examples and demos as a starting point, but don't be afraid to explore other projects, tools, and resources as you continue to learn and grow.

## Let's Get Started πŸš€

Now that we've set the stage, it's time to embark on your open source journey! In the next chapter, we'll dive into the definition of open source and explore its history, laying the groundwork for a deeper understanding of open source collaboration. Let's get started!

<!-- [Next Section ->](../intro-oss/02-what-is-open-source.md) -->

<a href="https://github.com/open-sauced/intro/edit/main/01-intro.md">
✏️ Edit this page
</a>
Loading