Skip to content

Commit

Permalink
feat: docsify to docusaurus (#222)
Browse files Browse the repository at this point in the history
* Add sidebar for docusaurus

* Add config and package json

* Add gitignore

* Add universal images

* Add course materials

* Add course materials

* Add index page and styles

* Change title

* Update docusaurus.config.js to link to contributing file

Co-authored-by: Ayu Adiati <[email protected]>

* remove extra footers

* Remove the rest of the footers

* Link to our blog on docs

* Update copy to detailed summary for course cards

* Capitalize titles

* Update titles for specificity

* Create specific title for intro

* Change title style

* Fix responsive layout

* Bump up the fontsize

* Replace docsify characters with admonitions

* Remove unused file

* fix: replace docsify with Docusaurus admonitions and exisiting admonitions' spacings

* fix: links to courses on main README

* fix: links to guidelines on main README

* fix: move h1 to title in front matter to address multiple top-level headings warnings

* feat: add maintainer glossary to the sidebar

* feat: add keywords to what-is-open-source.md

* feat: add keywords to why-open-source.md

* feat: add keywords to tools-to-be-successful.md

* feat: add keywords to how-to-contribute-to-open-source.md

* feat: add keywords to the-secret-sauce.md

* feat: add keywords to types-of-contributions.md

* feat: add a keyword to conclusion.md in intro to oss

* feat: add keywords to additional-resources.md in intro to oss

* feat: add keywords to README in intro to oss

* feat: add keywords to README becoming a maintainer

* fix: remove extra new lines in intro.md of becoming a maintainer

* feat: add keywords to intro.md in becoming a maintainer

* Add info to oss readme

* Remove intro from readme

* feat: add keywords to how-to-setup-your-project.md

* feat: add keywords to issues-and-pull-requests.md

* feat: add keywords to communication-and-collaboration.md

* fix: remove extra new lines

* fix: remove extra new lines

* feat: add keywords to maintaining-code-quality.md

* feat: add keywords to building-community.md

* feat: add keywords for maintainer-powerups.md

* feat: add keywords to your-team.md

* add keywords to metrics-and-analytics.md

* feat: add keywords to getting-practical.md

* feat: add keywords to maintainers-guestbook.md

* feat: add keywords to additional-resources.md

* feat: add keywords to glossary in becoming a maintainer

* feat: add keywords to glossary in intro to oss

* fix: specify language on fenced code blocks

* Change name in package.json

* Add netlify.toml to change publish to build

* Update node version

* Update path to img and gifs

---------

Co-authored-by: Ayu Adiati <[email protected]>
Co-authored-by: Ayu Adiati <[email protected]>
  • Loading branch information
3 people authored Jun 12, 2024
1 parent 7676667 commit c042f88
Show file tree
Hide file tree
Showing 68 changed files with 15,423 additions and 1,717 deletions.
Binary file added .DS_Store
Binary file not shown.
20 changes: 20 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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*
7 changes: 7 additions & 0 deletions Intro.code-workspace
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"folders": [
{
"path": "."
}
]
}
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@

This repository is the home of OpenSauced courses for people who want to learn to contribute to open source projects and for people who want to become project maintainers.

Head over to The Open Source Education Path with OpenSauced on [GitHub](./docs/README.md) or [the website](https://intro.opensauced.pizza/#/README) to start learning!
Head over to the **[Intro to Open Source Course](./docs/intro-to-oss/README.md)** or **[Becoming A Maintainer Course](./docs/becoming-a-maintainer/README.md)** on GitHub to start learning! Alternatively, visit [The Open Source Education Path with OpenSauced website](https://intro.opensauced.pizza/).

## **🤝 Contributing**

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).

- For information on how to contribute to the intro repository, check out the [Contributing Guidelines](./docs/CONTRIBUTING.md).
- For information on how to contribute to the intro repository, check out the [Contributing Guidelines](./contributing/CONTRIBUTING.md).

- To translate our Intro to Open Source or Becoming a Maintainer course, check out our [🌐 i18n Guidelines](./docs/i18n-guidelines.md).
- To translate our Intro to Open Source or Becoming a Maintainer course, check out our [🌐 i18n Guidelines](./contributing/i18n-guidelines.md).

## **🍕 Community**

Expand Down
4 changes: 3 additions & 1 deletion contributing/i18n-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,6 @@ When it comes to reviewing a translation PR, ask yourself the following question

When you think a PR is ready to be merged after your suggestions were addressed (if any), approve it through GitHub's "Review Changes" button or leave an "LGTM!" in the comment section and tag the `@open-sauced/docs` maintainers.

?> “LGTM” is an abbreviation of “Looks Good to Me” or “Let’s Get to Merging”, often used to approve pull requests.
:::info
“LGTM” is an abbreviation of “Looks Good to Me” or “Let’s Get to Merging”, often used to approve pull requests.
:::
Empty file removed docs/.nojekyll
Empty file.
45 changes: 0 additions & 45 deletions docs/README.md

This file was deleted.

9 changes: 0 additions & 9 deletions docs/_navbar.md

This file was deleted.

23 changes: 0 additions & 23 deletions docs/_sidebar.md

This file was deleted.

23 changes: 11 additions & 12 deletions docs/becoming-a-maintainer/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +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", "Becoming a Maintainer with OpenSauced", "becoming an open source maintainer", "open source course", "open source course for beginners", "maintaining open source projects course", "maintaining open source projects course for beginners", "open source maintainers", "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.

Expand Down Expand Up @@ -63,7 +62,11 @@ As this is the beginning of your open source maintainer journey, we've also prov

If you are taking this course on our GitHub repository, navigate to the [`intro.md` file](intro.md) to start the course. Alternatively, visit the [Becoming a Maintainer with OpenSauced on the website](https://intro.opensauced.pizza/#/becoming-a-maintainer/) and start reading!

?> **Tip:** Each chapter builds on the previous one, so we recommend reading them in order.
:::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.

Expand All @@ -78,7 +81,3 @@ To learn more about using OpenSauced to build your open source project, check ou
We hope you find this course informative and useful! If you have any questions or feedback, please don't hesitate to open an issue or reach out to us in the [Community](https://github.com/orgs/open-sauced/discussions).

Happy learning and contributing!

<footer>
<a href="https://github.com/open-sauced/intro/blob/main/docs/becoming-a-maintainer/README.md">✏️ Edit this page</a>
</footer>
5 changes: 0 additions & 5 deletions docs/becoming-a-maintainer/_navbar.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/becoming-a-maintainer/_sidebar.md

This file was deleted.

11 changes: 6 additions & 5 deletions docs/becoming-a-maintainer/additional-resources.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Additional Resources
---
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"]
---

On this page, you will find additional resources to help you learn more about all things around open source maintainers.

Expand All @@ -20,7 +25,3 @@ On this page, you will find additional resources to help you learn more about al
- [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)

<footer>
<a href="https://github.com/open-sauced/intro/blob/main/docs/becoming-a-maintainer/additional-resources.md">✏️ Edit this page</a>
</footer>
11 changes: 6 additions & 5 deletions docs/becoming-a-maintainer/building-community.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Building and Nurturing a Welcoming and Supportive Community
---
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"]
---

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.

Expand Down Expand Up @@ -125,7 +130,3 @@ A positive community culture that encourages diverse contributions and fosters n
However, building a positive community culture is not a one-time task; it requires continuous effort and commitment from everyone involved. You must invest in promoting diversity and inclusion, encouraging collaboration and teamwork, and fostering a sense of belonging. Doing so can create a culture of trust and respect that enables your community and projects to thrive. In short, building and nurturing a welcoming and supportive community is the right thing to do and a great strategy to help your project and your community succeed.

In the [next chapter](maintainer-powerups.md), we will discuss tools and features on GitHub that can help save maintainers time.

<footer>
<a href="https://github.com/open-sauced/intro/blob/main/docs/becoming-a-maintainer/building-community.md">✏️ Edit this page</a>
</footer>
17 changes: 9 additions & 8 deletions docs/becoming-a-maintainer/communication-and-collaboration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# How to Communicate and Collaborate Effectively
---
id: communication-and-collaboration
title: "How to Communicate and Collaborate Effectively"
sidebar_label: "Effective Communication and Collaboration"
keywords: ["communication and collaboration", "effective communication and collaboration in open source", "open source community communication strategies", "managing communication in open source", "fostering collaboration in open source", "best practices for communication in open source communities", "using Discord/Slack/Github Discussions for open source communication", "how to handle conflicts in open source community", "open source maintainers", "Open Source", "Open Source Community"]
---

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.

Expand Down Expand Up @@ -136,11 +141,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**

Expand Down Expand Up @@ -200,15 +205,11 @@ 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.
>
> I hope you find this feedback helpful. If there's anything I can do to support you, please let me know."
In the [next chapter](maintaining-code-quality.md), we will talk about maintaining code quality and documentation.

<footer>
<a href="https://github.com/open-sauced/intro/blob/main/docs/becoming-a-maintainer/communication-and-collaboration.md">✏️ Edit this page</a>
</footer>
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# Community Course Translations
---
id: community-translations
title: "Community Course Translations"
sidebar_label: "community translations"
keywords: ["community translations", "Open Source", "Open Source Community"]
---

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.

Expand Down
Loading

0 comments on commit c042f88

Please sign in to comment.