From 20f4dfe8abc2bea0b5f4463e15c8f9d2de25e4d9 Mon Sep 17 00:00:00 2001 From: BekahHW <34313413+BekahHW@users.noreply.github.com> Date: Thu, 30 Nov 2023 10:12:21 -0500 Subject: [PATCH] feat: Update sidebar with new sections (#217) --- docs/community/pr-velocity.md | 11 ----------- docs/features/dev-card.md | 3 ++- docs/features/lists.md | 2 +- docs/{community => welcome}/faqs.md | 0 docs/{community => welcome}/glossary.md | 0 docs/welcome/opensauced-intro.md | 25 +++++++++++++++++++++++++ sidebars.js | 14 +++++++++++--- 7 files changed, 39 insertions(+), 16 deletions(-) delete mode 100644 docs/community/pr-velocity.md rename docs/{community => welcome}/faqs.md (100%) rename docs/{community => welcome}/glossary.md (100%) create mode 100644 docs/welcome/opensauced-intro.md diff --git a/docs/community/pr-velocity.md b/docs/community/pr-velocity.md deleted file mode 100644 index 975b3150..00000000 --- a/docs/community/pr-velocity.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: pr-velocity -title: 'PR Velocity' -sidebar_label: 'PR Velocity' -keywords: - - pr-velocity ---- - -The PR Velocity as shown in purple in the screenshot below, measures the percentage and amount of days that pull requests that are merged. It's a great way to track the progress of your open source contributions. - -![PR Velocity Example](../../static/img/pr-velocity-example.png) diff --git a/docs/features/dev-card.md b/docs/features/dev-card.md index 043157cd..5f8bd0d7 100644 --- a/docs/features/dev-card.md +++ b/docs/features/dev-card.md @@ -6,7 +6,8 @@ keywords: - dev-card --- -The Dev card feature is what we like to call your "open source business card." On the front, you see your username, the number of pull requests you have created, repositories you contribute to, a `View Profile` button that takes you to your dashboard, and a green icon, which describes your activity rate. When you click on the back of your card, you see additional information, including your OpenSauced profile's headline, the date of your first contribution on GitHub, and your [PR velocity rate](../../docs/community/pr-velocity.md). +The Dev card feature is what we like to call your "open source business card." On the front, you see your username, the number of pull requests you have created, repositories you contribute to, a `View Profile` button that takes you to your dashboard, and a green icon, which describes your activity rate. When you click on the back of your card, you see additional information, including your OpenSauced profile's headline, the date of your first contribution on GitHub, and your [PR velocity rate](https://docs.opensauced.pizza/community/glossary/#pr-velocity). +(../../docs/welcome/glossary/#pr-velocity.md). ![screenshot of front and back of a dev card](../../static/img/a-dev-card.png) Whether you are a person who's just beginning their open source journey or a maintainer looking for more contributors and/or sponsors, the Dev Card is a shareable snapshot of your contributions, skills, and engagement in the open source community. diff --git a/docs/features/lists.md b/docs/features/lists.md index d6eba064..0ea70b30 100644 --- a/docs/features/lists.md +++ b/docs/features/lists.md @@ -25,4 +25,4 @@ There are three ways to add a list: Once your list is created, you'll be able to see an overview of all the contributors in your list, a graph of their activity, and a detailed breakdown of the contributors. -If you're having trouble syncing your Organization or Team, check out our [Sync Your GitHub Team in our FAQs](../community/faqs.md#sync-your-github-team). +If you're having trouble syncing your Organization or Team, check out our [Sync Your GitHub Team in our FAQs](../welcome/faqs.md#sync-your-github-team). diff --git a/docs/community/faqs.md b/docs/welcome/faqs.md similarity index 100% rename from docs/community/faqs.md rename to docs/welcome/faqs.md diff --git a/docs/community/glossary.md b/docs/welcome/glossary.md similarity index 100% rename from docs/community/glossary.md rename to docs/welcome/glossary.md diff --git a/docs/welcome/opensauced-intro.md b/docs/welcome/opensauced-intro.md new file mode 100644 index 00000000..afb49c43 --- /dev/null +++ b/docs/welcome/opensauced-intro.md @@ -0,0 +1,25 @@ +--- +id: opensauced-intro +title: 'What is OpenSauced?' +sidebar_label: 'What is OpenSauced?' +keywords: + - OpenSauced +--- + +# OpenSauced: Your Open Source Partner + +OpenSauced is a platform dedicated to nurturing and expanding your open source community, while recognizing every contributor's impact. + +**Our OpenSauced dashboard allows you to:** + +- **Understand Open Source Projects:** Get a comprehensive view of open source contributors and their engagement. +- **Discover Valuable Insights:** Identify key contributors, emerging trends, and valuable project insights. +- **Engage Effectively:** Reach out to community members to foster involvement and collaboration. +- **Generate Reports:** Create insightful reports to visualize and communicate the influence of your community. +- **Collaborate with your team:** Work together with your team or other contributors for a holistic approach to open source. +- **See Beyond Green Squares:** Connect with various aspects of open source contribution and community activities. + +## Who is OpenSauced for? +OpenSauced is for maintainers, OSPOs, contributors, companies, community managers, and anyone who is interested in what's happening in the open source ecosystem. + +Embarking on an OpenSauced journey enhances your growth and community engagement. Let's launch your open source success story 🚀 diff --git a/sidebars.js b/sidebars.js index 4c9a09e8..07dcb80c 100644 --- a/sidebars.js +++ b/sidebars.js @@ -12,6 +12,16 @@ module.exports = { docs: [ "introduction", + { + type: "category", + label: "Getting started", + collapsed: false, + items: [ + "welcome/opensauced-intro", + "welcome/glossary", + "welcome/faqs" + ], + }, { type: "category", label: "Features", @@ -36,13 +46,11 @@ module.exports = { }, { type: "category", - label: "Getting started", + label: "Community", collapsed: false, items: [ "community/welcome-to-the-community", "community/100-days-of-oss", - "community/faqs", - "community/glossary", ], }, {