Skip to content

Commit

Permalink
feat: update docs to be more specific and reflect current features (#155
Browse files Browse the repository at this point in the history
)

* Add twitter space links

* Add 100days to welcome

* Add highlgiht example

* Update copy

* Update insights copy

* Switch to a larger img for highlight

* Change where the link starts and ends

* Update npm

* Update package.json

* Update engines

* Update note version in ci configuration

* Update node v in build job

* Update docs/community/highlights.md

Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com>

* Update docs/community/highlights.md

Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com>

* Update node v

* Update docs/community/insights.md

Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com>

* Revert "Update node v"

This reverts commit 781e94b.

* Revert changes

* Update package json

* Clarify insights language

---------

Co-authored-by: Christine Belzie <105683440+CBID2@users.noreply.github.com>
  • Loading branch information
BekahHW and CBID2 committed Sep 9, 2023
1 parent 05cb60f commit 45abbf7
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 10 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ jobs:
- name: "🔧 setup node"
uses: actions/setup-node@v2.1.5
with:
node-version: 16
node-version: 18

- name: "🔧 install npm@latest"
run: npm i -g npm@latest
Expand Down Expand Up @@ -144,7 +144,7 @@ jobs:
- name: "🔧 setup node"
uses: actions/setup-node@v2.1.5
with:
node-version: 16
node-version: 18

- name: "🔧 install npm@latest"
run: npm i -g npm@latest
Expand Down
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
13 changes: 11 additions & 2 deletions docs/community/highlights.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ 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.

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:
1. a Dev.to blog post
2. a Pull request
3. a issue

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

For more examples of highlights, go to the [OpenSauced Insights feed](https://insights.opensauced.pizza/feed).

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 providing data to help you make decisions that can define your approach to open source and tell the story of your project or contribution journey.

![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.
- 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.
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.

0 comments on commit 45abbf7

Please sign in to comment.