Skip to content

Commit

Permalink
feat: rearranges sections for easy consumption (open-sauced#118)
Browse files Browse the repository at this point in the history
* feat: added start.js

* rearrange minus FAQs

* we got FAQs

* Apply grammar and spelling suggestions from code review

Co-authored-by: Christine Belzie <[email protected]>

---------

Co-authored-by: Christine Belzie <[email protected]>
  • Loading branch information
bdougie and CBID2 authored Jul 12, 2023
1 parent cc54685 commit 257a44c
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 27 deletions.
15 changes: 15 additions & 0 deletions docs/community/faqs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: faqs
title: 'Frequently asked Questions'
sidebar_label: 'FAQS'
keywords:
- faqs
---

1. **How do I find good first issues?**
we recommend checking out sites like [good first issues](https://goodfirstissues.com/) and [first timers only](https://www.firsttimersonly.com/). they will lead you to projects and issues worth working on. we also recommend using the `good first issue` label in the search engine of the project you want to contribute to. check out [this youtube short from github](https://www.youtube.com/watch?v=k3l_rurkoxg) to learn more. furthermore, check out our daily "who's looking for open source contributors?" on [dev.to](https://dev.to/opensauced/whos-looking-for-open-source-contributors-week-46-247i)
1. **My contribution does not show up on my Opensauced profile. how do I fix it?**
we suggest creating a [insight page](https://github.com/open-sauced/intro/blob/main/05-how-to-contribute-to-open-source.md#discovering-open-source-with-opensauced) or adding your merged pull request to [the highlights page](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md#develop-your-open-source-resume).

1. **I want to find "x" language or frameworks data. How do I find it?**
post your suggestion in our [feedback repository](https://github.com/orgs/open-sauced/discussions). we'd love to see it! :smile:
11 changes: 11 additions & 0 deletions docs/community/highlights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: highlights
title: 'Highlight your open source contributions'
sidebar_label: 'HiHighlight your open source contributions'
keywords:
- highlights
---

The Highlights feature is what we like to call the "glitzy pepperoni" of your OpenSauced profile. It's the place where you can display your favorite open source contributions whether it's an article you wrote for [Codecademy's Docs website](https://www.codecademy.com/pages/contribute-docs), revising one of the lessons on [freeCodeCamp's curricula](https://contribute.freecodecamp.org/#/index?id=learning-platform), or creating a tutorial for people who use [Audacity](https://support.audacityteam.org/community/contributing/tutorials).

Eager to get started? Check out[the Effectively Highlights section in our free "Intro to Open Source" course](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md#effectively-highlight-your-contributions) to learn more.
10 changes: 0 additions & 10 deletions docs/contributing/introduction-to-contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,16 +147,6 @@ Do you have questions? Join the conversation in our [Discord](https://discord.gg
- Use [CSS variables](https://github.com/open-sauced/open-sauced/blob/HEAD/src/styles/variables.js)
- Always use [rel="noreferrer" on all target="\_blank" links](https://web.dev/external-anchors-use-rel-noopener/).

## Frequently Asked Questions

1. **How do I find good first issues?**
We recommend checking out sites like [Good First Issues](https://goodfirstissues.com/) and [First Timers Only](https://www.firsttimersonly.com/). They will lead you to projects and issues worth working on. We also recommend using the `Good First Issue` label in the search engine of the project you want to contribute to. Check out [this YouTube Short from GitHub](https://www.youtube.com/watch?v=k3l_rurKOXg) to learn more. Furthermore, check out our daily "Who's looking for open source contributors?" on [Dev.to](https://dev.to/opensauced/whos-looking-for-open-source-contributors-week-46-247i)
1. **My contribution does not show up on my OpenSauced profile. How do I fix it?**
We suggest creating a [Insight page](https://github.com/open-sauced/intro/blob/main/05-how-to-contribute-to-open-source.md#discovering-open-source-with-opensauced) or adding your merged pull request to [the Highlights Page](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md#develop-your-open-source-resume).

1. **I want to find "X" language or frameworks data. How do I find it?**
Post your suggestion in our [Feedback repository](https://github.com/orgs/open-sauced/discussions). We'd love to see it! :smile:

## License

By contributing to the OpenSauced project, you agree that your contributions will be licensed
Expand Down
7 changes: 0 additions & 7 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,3 @@ sidebar_label: Introduction to OpenSauced 🍕
[Watch this on YouTube](https://www.youtube.com/watch?v=h8gwrzis-dY&list=PLHyZ0Wz_A44XAE-6Gbd69pZLTdqWdwlBx&index=1&t=2s)

OpenSauced provides guidance for new contributors to find their next contribution. Our approach towards onboarding offers a way to track contributions through a GitHub-powered dashboard.

## Highlights

The Highlights feature is what we like to call the "glitzy pepperoni" of your OpenSauced profile. It's the place where you can display your favorite open source contributions whether it's an article you wrote for [Codecademy's Docs website](https://www.codecademy.com/pages/contribute-docs), revising one of the lessons on [freeCodeCamp's curricula](https://contribute.freecodecamp.org/#/index?id=learning-platform), or creating a tutorial for people who use [Audacity](https://support.audacityteam.org/community/contributing/tutorials).

Eager to get started? Check out[the Effectively Highlights Your Contributions section in our free "Intro to Open Source" course](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md#effectively-highlight-your-contributions) to learn more.
- Ready to start contributing? Start here.
23 changes: 13 additions & 10 deletions sidebars.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

/**
* Creating a sidebar enables you to:
- create an ordered group of docs
Expand All @@ -12,6 +13,17 @@
module.exports = {
docs: [
'introduction',
{
type: 'category',
label: 'Getting started',
collapsed: false,
items: [
'community/welcome-to-the-community',
'community/highlights',
'community/100-days-of-oss',
'community/faqs'
],
},
{
type: 'category',
label: 'Contributing guide',
Expand Down Expand Up @@ -52,16 +64,7 @@ module.exports = {
'chrome-extension/using-the-chrome-extension',
],
},
{
type: 'category',
label: 'Community',
collapsed: false,
items: [
'community/welcome-to-the-community',
'community/100-days-of-oss'
],
},

],
};

//

0 comments on commit 257a44c

Please sign in to comment.