Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: update docs to be more specific and reflect current features #155

Merged
merged 22 commits into from
Sep 9, 2023
Merged
Show file tree
Hide file tree
Changes from 8 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
5 changes: 2 additions & 3 deletions docs/community/100-days-of-oss.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,8 @@ Use the link to sign up for a session.

### Weekly Twitter Spaces
Join us every Tuesday at 10:30a ET for our weekly Twitter Spaces sessions where we discuss open source topics, share insights, and connect with like-minded individuals. Follow us on [Twitter](https://twitter.com/saucedopen) to stay updated on upcoming sessions.
- [July 24 | 11:00a ET](https://twitter.com/i/spaces/1YpKkggOPBdKj)
- [August 1 | 10:30a](https://twitter.com/i/spaces/1vAxRAAnPErJl)
- [August 8 | 10:30a](https://twitter.com/i/spaces/1gqxvyyvPPnJB)
- [September 5 | 10:30a ET](https://twitter.com/i/spaces/1nAJErEOgDyxL?s=20)
- [September 12 | 10:30a](https://twitter.com/i/spaces/1lPKqBvEMwYGb?s=20)

More links to come!

Expand Down
10 changes: 8 additions & 2 deletions docs/community/highlights.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ 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).
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, share the story, and inspire others to join you in your open source journey. For maintainers, it's a great way to showcase your project, the issues that need support, and attract new contributors.
BekahHW marked this conversation as resolved.
Show resolved Hide resolved

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.
There are currently three types of highlights you can add to your profile: a Dev.to blog post, a pull request, or an issue.
BekahHW marked this conversation as resolved.
Show resolved Hide resolved

![Example highlight](../../static/img/highlight.svg)

For more examples of highlights, got to the [OpenSauced Insights feed](https://insights.opensauced.pizza/feed).
BekahHW marked this conversation as resolved.
Show resolved Hide resolved

Eager to get started? Check out the [Effectively Highlight Your Contribution section](https://github.com/open-sauced/intro/blob/main/06-the-secret-sauce.md#effectively-highlight-your-contributions) in our free "Intro to Open Source" course to learn more.
14 changes: 11 additions & 3 deletions docs/community/insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,17 @@ sidebar_label: 'Insights'
keywords:
- insights
---

The Insights feature is where you pick and view the repositories that you often contribute to. It's a great way to stay updated on their growth.
The Insights feature is your one-stop solution for understanding the pulse of your open-source projects and contributions. This feature is designed to provide a comprehensive view of your project's health and your individual contributions. From contribution trends to community health, OpenSauced Insights helps you make data-driven decisions that align with your goals. It's not just about numbers; it's about actionable intelligence that can redefine your approach to open source.
BekahHW marked this conversation as resolved.
Show resolved Hide resolved

![insight-pages-demo](../../static/gif/insight-page-demo.gif)

Craving for more? Check out the [Discovering Open-Source with OpenSauced](https://github.com/open-sauced/intro/blob/main/05-how-to-contribute-to-open-source.md#discovering-open-source-with-opensauced) section in our free beginner course on open source.
## How to use Insights
### Contributors
- Track your contributions and the impact you're making;
- Find new projects to contribute to;
- Discover other contributors to collaborate with.

### Maintainers
- Track the health of your project;
- Identify contributors who are making an impact;
BekahHW marked this conversation as resolved.
Show resolved Hide resolved
- Find new contributors to support your project.
1 change: 1 addition & 0 deletions docs/community/welcome-to-the-community.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,4 @@ Getting started with open source can be quite daunting for beginners, so we've p

- πŸ“ Check out our [Dev blog](https://dev.to/opensauced) where we provide resources for open-source contributors.
- πŸ“– Take our [Intro to Open Source Course](https://intro.opensauced.pizza/#/) to help you get started with open-source.
- πŸ“… Join our [#100DaysOfOSS Challenge](https://docs.opensauced.pizza/community/100-days-of-oss/) to help you grow your skills and gain real-world experience in open source.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": "1.42.0",
"private": true,
"engines": {
"node": ">=14",
"node": ">=18",
"npm": ">=7"
},
"scripts": {
Expand Down
1 change: 1 addition & 0 deletions static/img/highlight.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.