feat: migrate to latest docusaurus version and provide necessary upda…

…tes (#295) * Upgrade docusaurus to v 2 * Fix formatting to remove migration error * Update theme import * Add legacy-peer-deps * Fix broken internal link * Fix broken link * Make colors accessible * Add Robots.txt * Comment back in theme * Add global metadata keywords * Fix footer * Add support for darkmode accesibility * Escape formatting to prevent error * Escape curly braces * fix: change wording inside curly brackets for consistency --------- Co-authored-by: Ayu Adiati <retno.ayu98@gmail.com>
open-sauced · Apr 24, 2024 · 93df686 · 93df686
1 parent c49ce05
commit 93df686
Show file tree

Hide file tree

Showing 48 changed files with 16,641 additions and 8,919 deletions.
diff --git a/.npmrc b/.npmrc
@@ -5,3 +5,4 @@ loglevel="info"
 progress=false
 timing=false
 engine-strict=true
+legacy-peer-deps=true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,6 @@
+---
+: ""
+---
 # 📦 open-sauced/docs changelog
 
 [![conventional commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-  <br>
+  <br/>
 
   [![OpenSauced](https://i.ibb.co/7jPXt0Z/logo1-92f1a87f.png)](https://opensauced.pizza)
 

diff --git a/docs/community/100-days-of-oss.md b/docs/community/100-days-of-oss.md
@@ -2,14 +2,13 @@
 id: 100-days-of-oss
 title: "#100DaysOfOSS: Growing Skills and Real-World Experience"
 sidebar_label: "#100DaysOfOSS"
-keywords:
-  - "100 days of open source"
-  - "100 days of OSS"
-  - "Open source contribution"
-  - "Open source software development"
-  - "Open source projects for beginners"
-  - "Open source development"
-
+keywords: 
+- "100 days of open source" 
+- "100 days of OSS" 
+- "Open source contribution" 
+- "Open source software development" 
+- "Open source projects for beginners" 
+- "Open source development" 
 ---
 
 Inspired by the great work of the [#100DaysOfCode challenge](https://www.100daysofcode.com/), we're starting #100DaysOfOSS.

diff --git a/docs/community/hacktoberfest.md b/docs/community/hacktoberfest.md
@@ -2,13 +2,13 @@
 id: hacktoberfest
 title: "Join us for Hacktoberfest! 🎃"
 sidebar_label: "Join us for Hacktoberfest! 🎃"
-keywords:
-  - "hacktoberfest"
-  - "Open source contributions for Hacktoberfest"
-  - "Hacktoberfest participation guide"
-  - "Open source collaboration in October"
-  - "Hacktoberfest beginner-friendly projects"
-  - "How to get involved in Hacktoberfest"
+keywords: 
+- "hacktoberfest" 
+- "Open source contributions for Hacktoberfest"
+- "Hacktoberfest participation guide"
+- "Open source collaboration in October"
+- "Hacktoberfest beginner-friendly projects"
+- "How to get involved in Hacktoberfest"
 ---
 
 At OpenSauced, we love open source just as much as pizza! That's why we are participating in Hacktoberfest! 🎃

diff --git a/docs/community/welcome-to-the-community.md b/docs/community/welcome-to-the-community.md
@@ -2,12 +2,12 @@
 id: welcome-to-the-community
 title: "Welcome to the OpenSauced Community"
 sidebar_label: "Welcome to the Community"
-keywords:
-  - "welcome to the community"
-  - "The community welcomes you"
-  - "Get involved in the community"
-  - "Join our community"
-  - "Greetings from the community"
+keywords: 
+- "welcome to the community" 
+- "The community welcomes you" 
+- "Get involved in the community" 
+- "Join our community" 
+- "Greetings from the community" 
 ---
 
 Welcome to the OpenSauced community! At OpenSauced, we strive to bring collaboration and inspiration to every open source contributor and help build a global community of open source developers, empowering you to grow, innovate, and achieve greatness in the open.

diff --git a/docs/contributing/code-of-conduct.md b/docs/contributing/code-of-conduct.md
@@ -2,13 +2,13 @@
 id: code-of-conduct
 title: "Code of Conduct"
 sidebar_label: "Code of Conduct"
-keywords:
-  - "code of conduct"
-  - "Community guidelines"
-  - "Guidelines for behavior"
-  - "Interaction guidelines"
-  - "rules and guidelines"
-  - "Behavioral expectations"
+keywords: 
+- "code of conduct" 
+- "Community guidelines" 
+- "Guidelines for behavior" 
+- "Interaction guidelines" 
+- "rules and guidelines" 
+- "Behavioral expectations" 
 ---
 
 ## Our Pledge

diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md
@@ -2,18 +2,18 @@
 id: introduction-to-contributing
 title: "Introduction to Contributing"
 sidebar_label: "Introduction to Contributing"
-keywords:
-  - "introduction to contributing"
-  - "Getting started with contributions"
-  - "New contributor guide"
-  - "How to contribute effectively"
-  - "Contribution essentials"
-  - "Open source contribution guide"
-  - "Making your first contribution"
-  - "Beginner-friendly contributions"
-  - "Contributing to open source projects"
-  - "Starting your contribution journey"
-  - "First time contributor tips"
+keywords: 
+- "introduction to contributing" 
+- "Getting started with contributions" 
+- "New contributor guide" 
+- "How to contribute effectively" 
+- "Contribution essentials" 
+- "Open source contribution guide" 
+- "Making your first contribution" 
+- "Beginner-friendly contributions" 
+- "Contributing to open source projects" 
+- "Starting your contribution journey" 
+- "First time contributor tips" 
 ---
 
 Contributions are always welcome, no matter how large or small. Before contributing,

diff --git a/docs/contributing/opensauced-maintainers-guide/community-maintainers-guide.md b/docs/contributing/opensauced-maintainers-guide/community-maintainers-guide.md
@@ -2,14 +2,14 @@
 id: community-maintainers-guide
 title: "OpenSauced Community Maintainers Guidelines"
 sidebar_label: "Community Maintainers Guidelines"
-keywords:
-  - "opensauced community maintainers guidelines"
-  - "opensauced community maintainers"
-  - "maintainers guidelines"
-  - "open source maintainers guidelines"
-  - "open source maintainer"
-  - "open source project management"
-  - "community management in open source"
+keywords: 
+- "opensauced community maintainers guidelines" 
+- "opensauced community maintainers" 
+- "maintainers guidelines" 
+- "open source maintainers guidelines" 
+- "open source maintainer" 
+- "open source project management" 
+- "community management in open source" 
 ---
 
 Welcome to OpenSauced Community Maintainers guidelines!
@@ -51,7 +51,7 @@ Good first issues mainly aim for complete beginners and someone new to OpenSauce
 
 ### Assigning Issues
 
-- The `good first issue` can only be assigned **once per contributor**. <br /> Respond with something like, "Hey {username}, we appreciate all the contributions lately! We'd love to give someone new a chance to take on this good first issue, but keep checking back as we post new issues frequently."
+- The `good first issue` can only be assigned **once per contributor**. <br /> Respond with something like, "Hey \{@username}\, we appreciate all the contributions lately! We'd love to give someone new a chance to take on this good first issue, but keep checking back as we post new issues frequently."
 - Issues outside the `good first issue` can be assigned **max. 2 issues per contributor at a time**. <br /> We love contributions. But we want to equip contributors to succeed by giving them time to complete issues. Through experience, we've found that two issues at a time allows them to focus on completing the issue and supports maintainers by not having issues open for long periods.
 
 ## Pull Request Management
@@ -80,7 +80,7 @@ Good first issues mainly aim for complete beginners and someone new to OpenSauce
 - Do not approve changes or dismiss reviews from a maintainer even if the contributor has completed the change requests. Re-request review instead.
 - If you have the time, it's great to encourage contributors with a positive message like these:
 
-  - "Thanks for contributing, [name of contributor]. Join our [Discord](https://discord.com/invite/U2peSNf23P) community for more updates on OpenSauced and to find more projects."
+  - "Thanks for contributing, \{@username}\. Join our [Discord](https://discord.com/invite/U2peSNf23P) community for more updates on OpenSauced and to find more projects."
 
   - A personal message acknowledging their impact.
 

diff --git a/docs/contributing/opensauced-maintainers-guide/maintainers-guide.md b/docs/contributing/opensauced-maintainers-guide/maintainers-guide.md
@@ -2,12 +2,12 @@
 id: maintainers-guide
 title: "OpenSauced Maintainers Guide"
 sidebar_label: "OpenSauced Maintainers Guide"
-keywords:
-  - "maintainers guide"
-  - "open source maintainers guide" 
-  - "open source maintainer"
-  - "open source project management"
-  - "community management in open-source" 
+keywords: 
+- "maintainers guide" 
+- "open source maintainers guide" 
+- "open source maintainer" 
+- "open source project management" 
+- "community management in open-source" 
 ---
 
 Welcome to the OpenSauced Maintainers Guide for contributors who are interested in being part of the maintainer team for OpenSauced repositories.

diff --git a/docs/contributing/set-up-authentication.md b/docs/contributing/set-up-authentication.md
@@ -2,16 +2,16 @@
 id: set-up-authentication
 title: "Set Up Authentication"
 sidebar_label: "Set Up Authentication"
-keywords:
-  - "set up authentication"
-  - "Authentication setup guide"
-  - "Setting up secure login"
-  - "User authentication configuration"
-  - "Authentication system setup"
-  - "Authentication implementation steps"
-  - "Authentication setup tutorial"
-  - "Setting up user authorization"
-  - "Authentication best practices"
+keywords: 
+- "set up authentication" 
+- "Authentication setup guide" 
+- "Setting up secure login" 
+- "User authentication configuration" 
+- "Authentication system setup" 
+- "Authentication implementation steps" 
+- "Authentication setup tutorial" 
+- "Setting up user authorization" 
+- "Authentication best practices" 
 ---
 
 You need to obtain an authentication token to interact with the OpenSauced public API as an authenticated user.

diff --git a/docs/contributing/technical/resolve-merge-conflicts.md b/docs/contributing/technical/resolve-merge-conflicts.md
@@ -2,20 +2,19 @@
 id: resolve-merge-conflicts
 title: "Resolve Merge Conflicts"
 sidebar_label: "Resolve Merge Conflicts"
-keywords:
-  - "resolve merge conflicts"
-  - "solve merge conflicts"
-  - "Git merge conflict"
-  - "Merge conflict resolution"
-  - "Merge conflict prevention"
-  - "Merge conflict handling"
-  - "Merge conflict management"
-  - "Merge conflict avoidance"
-  - "Merge conflict workflow"
-  - "Merge conflict strategies"
-  - "Merge conflict best practices"
-  - "Merge conflict tools"
-
+keywords: 
+- "resolve merge conflicts" 
+- "solve merge conflicts" 
+- "Git merge conflict" 
+- "Merge conflict resolution" 
+- "Merge conflict prevention" 
+- "Merge conflict handling" 
+- "Merge conflict management" 
+- "Merge conflict avoidance" 
+- "Merge conflict workflow" 
+- "Merge conflict strategies" 
+- "Merge conflict best practices" 
+- "Merge conflict tools" 
 ---
 
 When you are working on any of the OpenSauced repositories, you might run into a merge conflict. A merge conflict occurs when multiple conflicting changes are made to the same line in a file. Merge conflicts happen the most when you open a pull request, as the release process generally updates `npm-shrinkwrap.json`.

diff --git a/docs/contributing/technical/setup-repo-with-git.md b/docs/contributing/technical/setup-repo-with-git.md
@@ -2,17 +2,17 @@
 id: setup-repo-with-git
 title: "Setting Up a Repository with Git and GitHub"
 sidebar_label: "Setting Up a Repository with Git and GitHub"
-keywords:
-  - "setting up a repository with Git and GitHub"
-  - "working with git and github"
-  - "GitHub repository creation"
-  - "GitHub repository workflow"
-  - "GitHub repository initialization"
-  - "GitHub repository hosting"
-  - "GitHub repository collaboration"
-  - "GitHub repository version control"
-  - "GitHub repository deployment"
-  - "GitHub repository setup"  
+keywords: 
+- "setting up a repository with Git and GitHub" 
+- "working with git and github" 
+- "GitHub repository creation" 
+- "GitHub repository workflow" 
+- "GitHub repository initialization" 
+- "GitHub repository hosting" 
+- "GitHub repository collaboration" 
+- "GitHub repository version control" 
+- "GitHub repository deployment" 
+- "GitHub repository setup" 
 ---
 
 

diff --git a/docs/contributing/triage-guide.md b/docs/contributing/triage-guide.md
@@ -2,18 +2,18 @@
 id: triage-guide
 title: "Triage Guide"
 sidebar_label: "Triage Guide"
-keywords:
-  - "triage guide"
-  - "Issue triage best practices"
-  - "GitHub triage process"
-  - "Pull request triage steps"
-  - "Triage workflow tutorial"
-  - "Effective issue management"
-  - "Open source contribution triage"
-  - "Triage for project maintainers"
-  - "Streamlining triage efforts"
-  - "Collaborative issue handling"
-  - "Contributor triage assistance"
+keywords: 
+- "triage guide" 
+- "Issue triage best practices" 
+- "GitHub triage process" 
+- "Pull request triage steps" 
+- "Triage workflow tutorial" 
+- "Effective issue management" 
+- "Open source contribution triage" 
+- "Triage for project maintainers" 
+- "Streamlining triage efforts" 
+- "Collaborative issue handling" 
+- "Contributor triage assistance" 
 ---
 
 ## How to Join the Triage Team

diff --git a/docs/contributors/contributors-guide.md b/docs/contributors/contributors-guide.md
@@ -2,9 +2,9 @@
 id: contributors-guide-to-open-sauced
 title: "Contributors Guide to OpenSauced"
 sidebar_label: Contributors Guide to OpenSauced
-keywords:
-  - contributors
-  - guides
+keywords: 
+- "contributors"
+- "guides"
 ---
 
 ## Introduction to OpenSauced for Contributors
@@ -199,7 +199,7 @@ There are three tabs that provide you with more information on these repositorie
 
 ### Overview
 
-The "Overview" tab gives you a high-level view of the contributors in your list, including the total number of commits in the last 30 days and the types of contributors: [Active](../welcome/glossary.md/#active-contributors), [New](../welcome/glossary.md#new-contributors), and [Alumni](../welcome/glossary.md#alumni-contributors).
+The "Overview" tab gives you a high-level view of the contributors in your list, including the total number of commits in the last 30 days and the types of contributors: [Active](../welcome/glossary.md#active-contributors), [New](../welcome/glossary.md#new-contributors), and [Alumni](../welcome/glossary.md#alumni-contributors).
 
 ### Activity
 

diff --git a/docs/features/connections.md b/docs/features/connections.md
@@ -2,17 +2,17 @@
 id: connections
 title: "Grow Your Network with Our Connections Feature!"
 sidebar_label: "Connections"
-keywords:
-  - "connections"
-  - "Network connections"
-  - "Professional connections"
-  - "Building connections"
-  - "Online connections"
-  - "Networking opportunities"
-  - "tech connections"
-  - "grow network"
-  - "grow connection"
-  - "Community connections"
+keywords: 
+- "connections" 
+- "Network connections" 
+- "Professional connections" 
+- "Building connections" 
+- "Online connections" 
+- "Networking opportunities" 
+- "tech connections" 
+- "grow network" 
+- "grow connection" 
+- "Community connections" 
 ---
 
 ## What are Connections?

diff --git a/docs/features/contributor-insights.md b/docs/features/contributor-insights.md
@@ -2,13 +2,13 @@
 id: contributor-insights
 title: "Organize and Monitor Your Contributors"
 sidebar_label: "Contributor Insights"
-keywords:
-  - "contributor insights"
-  - "contributors"
-  - "organize"
-  - "Monitor Contributors"
-  - "Organize Contributors"
-  - "Contributor Contributor Insights Management"
+keywords: 
+- "contributor insights" 
+- "contributors" 
+- "organize" 
+- "Monitor Contributors" 
+- "Organize Contributors" 
+- "Contributor Contributor Insights Management" 
 ---
 
 The Contributor Insights feature enables you to categorize, monitor, and analyze different groups of contributors within open source projects. With the Contributor Insights feature, gain granular insights into each contributor's activity and contributions.