Skip to content

Commit

Permalink
Merge branch 'main' into chore-docs-pdf
Browse files Browse the repository at this point in the history
  • Loading branch information
a0m0rajab authored Nov 1, 2023
2 parents 829202c + bf370c8 commit 34b3769
Show file tree
Hide file tree
Showing 40 changed files with 696 additions and 217 deletions.
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
@open-sauced/triage
@open-sauced/docs
2 changes: 1 addition & 1 deletion .github/workflows/compliance.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ permissions:

jobs:
compliance:
uses: open-sauced/open-sauced/.github/workflows/compliance.yml@main
uses: open-sauced/hot/.github/workflows/compliance.yml@main
2 changes: 1 addition & 1 deletion .github/workflows/development.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ on:

jobs:
test:
uses: open-sauced/open-sauced/.github/workflows/development.yml@main
uses: open-sauced/hot/.github/workflows/development.yml@main
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/[email protected]
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/[email protected]
with:
node-version: 16
node-version: 18

- name: "🔧 install npm@latest"
run: npm i -g npm@latest
Expand Down
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

# Misc
.DS_Store
.env
.env.local
.env.development.local
.env.test.local
Expand All @@ -18,3 +19,7 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*


# custom
config.json
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18.17.0
150 changes: 150 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,156 @@

> All notable changes to this project will be documented in this file
## [1.49.0](https://github.com/open-sauced/docs/compare/v1.48.0...v1.49.0) (2023-10-31)


### Features

* Add lists to docs ([#193](https://github.com/open-sauced/docs/issues/193)) ([ceb5af5](https://github.com/open-sauced/docs/commit/ceb5af517c23446ba025403374275a1fe527cf72))

## [1.48.0](https://github.com/open-sauced/docs/compare/v1.47.0...v1.48.0) (2023-10-24)


### Documentation

* adding section for the Hot OpenSauced Project ([#197](https://github.com/open-sauced/docs/issues/197)) ([4555cb8](https://github.com/open-sauced/docs/commit/4555cb8bfff265a0704e419c1f3ae9e30535f810))

## [1.47.0](https://github.com/open-sauced/docs/compare/v1.46.0...v1.47.0) (2023-10-20)


### Features

* add algolia search functionality to docs ([#196](https://github.com/open-sauced/docs/issues/196)) ([4a2dd05](https://github.com/open-sauced/docs/commit/4a2dd0523cc2b3131a2a3b28f0ca31a546d2ffd8))

## [1.46.0](https://github.com/open-sauced/docs/compare/v1.45.1...v1.46.0) (2023-10-18)


### Features

* terminology added ([#184](https://github.com/open-sauced/docs/issues/184)) ([c3fcfc8](https://github.com/open-sauced/docs/commit/c3fcfc8fc908708339c3e3ca7a58cd40b2b8892a))

### [1.45.1](https://github.com/open-sauced/docs/compare/v1.45.0...v1.45.1) (2023-10-12)


### Bug Fixes

* add parallel structure ([#175](https://github.com/open-sauced/docs/issues/175)) ([c50e6ba](https://github.com/open-sauced/docs/commit/c50e6ba4cc27949a6f397dd970dcf516d36a06af))

## [1.45.0](https://github.com/open-sauced/docs/compare/v1.44.0...v1.45.0) (2023-10-10)


### Features

* creating separate section for setting up repo with Git ([#192](https://github.com/open-sauced/docs/issues/192)) ([d68a086](https://github.com/open-sauced/docs/commit/d68a0863b52d8c9b8c0cee0ffe48dd1965f4ab3d))

## [1.44.0](https://github.com/open-sauced/docs/compare/v1.43.1...v1.44.0) (2023-10-10)


### Features

* add Connections feature page ([#191](https://github.com/open-sauced/docs/issues/191)) ([d887897](https://github.com/open-sauced/docs/commit/d887897070cbe6f619ee57f948acc57a67167370))

### [1.43.1](https://github.com/open-sauced/docs/compare/v1.43.0...v1.43.1) (2023-10-02)


### Bug Fixes

* Change title and sidebar ([#187](https://github.com/open-sauced/docs/issues/187)) ([ceb3d0f](https://github.com/open-sauced/docs/commit/ceb3d0f8e4e575d6314ee3919261467f0d812403))

## [1.43.0](https://github.com/open-sauced/docs/compare/v1.42.0...v1.43.0) (2023-10-02)


### Features

* Add maintainers-guide ([#177](https://github.com/open-sauced/docs/issues/177)) ([e4e2dab](https://github.com/open-sauced/docs/commit/e4e2dabe232b8f87192abd8973b858dcfdf6ffda))
* adding page about hacktoberfest ([#179](https://github.com/open-sauced/docs/issues/179)) ([d9cedb7](https://github.com/open-sauced/docs/commit/d9cedb74451fa95950807634d7eedeb5ca3ff9f4))
* update docs to be more specific and reflect current features ([#155](https://github.com/open-sauced/docs/issues/155)) ([45abbf7](https://github.com/open-sauced/docs/commit/45abbf726e8dfac8b8e230b0dcf84751b9c96035))


### Bug Fixes

* text to be more concise [#160](https://github.com/open-sauced/docs/issues/160) ([#161](https://github.com/open-sauced/docs/issues/161)) ([18993ab](https://github.com/open-sauced/docs/commit/18993abd2225a03d54512bf3ebf0a004a2ec8920))
* Update Highlights page to fix broken path and provide more information. ([#164](https://github.com/open-sauced/docs/issues/164)) ([e0aab72](https://github.com/open-sauced/docs/commit/e0aab7279797dbcbec449dcc63cdaa3de5c84a1e))
* Update license language in contributing guide ([#152](https://github.com/open-sauced/docs/issues/152)) ([49539e8](https://github.com/open-sauced/docs/commit/49539e8b91fbf4c15f94aee40208a0e6fac76158))
* update node and npm versions ([#180](https://github.com/open-sauced/docs/issues/180)) ([f35a4c7](https://github.com/open-sauced/docs/commit/f35a4c78f781c886877ca297899bfc33e312d339))
* workflow.yml ([#162](https://github.com/open-sauced/docs/issues/162)) ([05cb60f](https://github.com/open-sauced/docs/commit/05cb60f562247e54c3fa72812ccee9ad59e726c7))


### Documentation

* adding a gif of doing a highlight on the website ([#137](https://github.com/open-sauced/docs/issues/137)) ([0a9d371](https://github.com/open-sauced/docs/commit/0a9d371e31684315852614a563657a60e98091b7))
* adding explainer page about Dev card ([#158](https://github.com/open-sauced/docs/issues/158)) ([4d48443](https://github.com/open-sauced/docs/commit/4d48443321c657bdd49289bebf2ba55af6974667))

## [1.42.0](https://github.com/open-sauced/docs/compare/v1.41.0...v1.42.0) (2023-08-30)


### Documentation

* replace url for finding good first issue ([#153](https://github.com/open-sauced/docs/issues/153)) ([d006a6c](https://github.com/open-sauced/docs/commit/d006a6c59ba3b57991418f4d9fb83a2a8a6fc23e))

## [1.41.0](https://github.com/open-sauced/docs/compare/v1.40.1...v1.41.0) (2023-08-30)


### Features

* add explainer page about PR velocity ([#151](https://github.com/open-sauced/docs/issues/151)) ([619574f](https://github.com/open-sauced/docs/commit/619574f6a865bf8b713d3a507bc94e2dd063b26b))

### [1.40.1](https://github.com/open-sauced/docs/compare/v1.40.0...v1.40.1) (2023-08-25)


### Bug Fixes

* the gif ([#149](https://github.com/open-sauced/docs/issues/149)) ([c4d8a1e](https://github.com/open-sauced/docs/commit/c4d8a1e79a7083222dc05aaab99009c8668840d3))

## [1.40.0](https://github.com/open-sauced/docs/compare/v1.39.3...v1.40.0) (2023-08-25)


### Documentation

* adding an explainer page and GIF on insight pages ([#138](https://github.com/open-sauced/docs/issues/138)) ([b957398](https://github.com/open-sauced/docs/commit/b957398cf5c3b98546724a87da99b2f932510b17))

### [1.39.3](https://github.com/open-sauced/docs/compare/v1.39.2...v1.39.3) (2023-08-24)


### Bug Fixes

* Documentation Link Misdirection ([#148](https://github.com/open-sauced/docs/issues/148)) ([180b032](https://github.com/open-sauced/docs/commit/180b0324dea21520e55da9afcd5dcd5b9fcd0d77))

### [1.39.2](https://github.com/open-sauced/docs/compare/v1.39.1...v1.39.2) (2023-08-23)


### Bug Fixes

* Incorrect Link Destination in Documentation ([#144](https://github.com/open-sauced/docs/issues/144)) ([c7adf37](https://github.com/open-sauced/docs/commit/c7adf375c8eff11744c55e074a82d5c48be31add))

### [1.39.1](https://github.com/open-sauced/docs/compare/v1.39.0...v1.39.1) (2023-08-22)


### Bug Fixes

* fix broken links ([#141](https://github.com/open-sauced/docs/issues/141)) ([81f27b9](https://github.com/open-sauced/docs/commit/81f27b9f234c430585497e96d4f03d264ca419c8))

## [1.39.0](https://github.com/open-sauced/docs/compare/v1.38.0...v1.39.0) (2023-08-21)


### Documentation

* fix some sentences in the "Welcome to the Community" and "Introduction to Storybook" section for clarity and fix some typos. ([#130](https://github.com/open-sauced/docs/issues/130)) ([812acde](https://github.com/open-sauced/docs/commit/812acdefbc9d428a7446040106f4e0784fd0fafd)), closes [#133](https://github.com/open-sauced/docs/issues/133)

## [1.38.0](https://github.com/open-sauced/docs/compare/v1.37.1...v1.38.0) (2023-08-15)


### Documentation

* revise information about templates ([#135](https://github.com/open-sauced/docs/issues/135)) ([321e8c9](https://github.com/open-sauced/docs/commit/321e8c9f9721e056ee4e7f1c9074cdda5fc0250c))

### [1.37.1](https://github.com/open-sauced/docs/compare/v1.37.0...v1.37.1) (2023-08-12)


### Bug Fixes

* Correct typo in resolve-merge-conflicts.md ([#128](https://github.com/open-sauced/docs/issues/128)) ([72f3b45](https://github.com/open-sauced/docs/commit/72f3b45faa0fd2378350230616d181a8ab66e696))

## [1.37.0](https://github.com/open-sauced/docs/compare/v1.36.1...v1.37.0) (2023-07-28)


Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM node:16-alpine as development
FROM node:18.17.0-alpine as development

WORKDIR /app

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This tool is meant to accelerate development on [OpenSauced](https://opensauced.

## 🤝 Contributing

We encourage you to contribute to OpenSauced! Please check out the [Contributing guide](https://docs.opensauced.pizza/contributing/introduction-to-contributing/) for guidelines about how to proceed.
We encourage you to contribute to OpenSauced! All contributors are required to abide by our [Code of Conduct](https://github.com/open-sauced/.github/blob/main/CODE_OF_CONDUCT.md). Please check out the [Contributing guide](https://docs.opensauced.pizza/contributing/introduction-to-contributing/) for guidelines about how to proceed with your contribution.

<img align="right" src="https://i.ibb.co/CJfW18H/ship.gif" width="200"/>

Expand Down
50 changes: 32 additions & 18 deletions docs/community/100-days-of-oss.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,40 @@ The beauty of this challenge is that you're not required to code. The main purpo

There are numerous ways to participate in the #100DaysOfOSS challenge, including:

- write issues to identify bugs or suggest new features;
- triage existing issues to help with prioritization;
- submit pull requests to contribute code changes;
- engage in the community by sharing your insights and knowledge;
- create or participate in discussions related to OSS topics;
- write a blog post or create content that supports an OSS project;
- update or write documentation to improve clarity and usability
- create content: give a talk or presentation on OSS, participate in or even start a Twitter Space write a blog post or create a video;
- maintain a project: review pull requests, triage issues, and respond to questions;
- support contributors working on OSS projects, providing guidance and support.

### Content creation
Love creating content? Here's how you can use this skill for the challenge:
- Give a talk or presentation on OSS.
- Participate in or even start a Twitter Space.
- Write a blog post or create a video.

### Project management
Want to improve your project management skills? Need to get better at communicating or giving feedback to others? Here's how you can use this skill for the challenge:
- Review pull requests.
- Triage issues.
- Open meaningful discussions.
- Write issues to identify bugs or suggest new features.

### Community Engagement and Leadership
Community experience is involved in many different tech jobs including support, success, Developer Relations, Developer Experience and more. Community experience can be a valuable skill to develop. Some ways you can do this:
- Engage in the community by sharing your insights and knowledge.
- Support contributors working on OSS projects, providing guidance and support.
- Create a study group or accountability group where you work on your goals.

### Technical Skills
This is a great team to show your technical growth. Here are some paths you can take:
- Update or write documentation to improve clarity and usability.
- Maintain a project: review pull requests, triage issues, and respond to questions.
- Submit pull requests to contribute code changes.

### Tracking your progress
To keep track of your progress, post on social media, your blog, or any other platform you prefer with what progress you made, the day of the challenge indicated by 'D'and include the hashtag #100DaysOfOSS. For example, if you're on day one, you could say, "Today, I reviewed the documentation for the [OpenSauced/Insights](https://github.com/open-sauced/insights) repository. D1 #100daysOfOSS." Then, on day two, you would continue with D2, and so on.

Here's what you can do if you're ready to join this challenge:
- [Sign up](https://docs.google.com/forms/d/e/1FAIpQLScoq6ORpkzUg3Cqxd3EeNnMP6HIJ3uemPhSHs8sYZALmbpeVg/viewform?usp=sharing) with OpenSauced to receive a coupon code for 12 months of free access to all OpenSauced's paid features, and for the chance to opt in to receive updates, event invites, and resources to help you succeed.
- [tweet out your commitment today](https://twitter.com/intent/tweet?text=I%27m%20joining%20the%20%23100DaysOfOSS%20challenge%20with%20%40saucedopen%20to%20grow%20my%20skills%2C%20gain%20real-world%20experience%20in%20open%20source%2C%20and%20to%20make%20a%20positive%20impact%20on%20the%20OSS%20Community!) or share on your platform of choice!
- [Tweet out your commitment today](https://twitter.com/intent/tweet?text=I%27m%20joining%20the%20%23100DaysOfOSS%20challenge%20with%20%40saucedopen%20to%20grow%20my%20skills%2C%20gain%20real-world%20experience%20in%20open%20source%2C%20and%20to%20make%20a%20positive%20impact%20on%20the%20OSS%20Community!) or share on your platform of choice!

## The Official Kickoff
We're starting 100 days from the end of [Hacktoberfest](https://hacktoberfest.com/), a month-long celebration of open source contributions. Starting July 23rd, we'll provide continuous support, daily inspirational tweets, and engaging events to help you stay motivated and make progress.
We're starting 100 days on July 23rd to the end of [Hacktoberfest](https://hacktoberfest.com/), a month-long celebration of open source contributions. We'll provide continuous support, daily inspirational tweets, and engaging events to help you stay motivated and make progress.

Don't worry if you're unable to start on the same day as everyone else. The #100DaysOfOSS challenge is flexible, and you can join in whenever you're ready. Just jump in at any point and begin with day one of your personal challenge.

Expand All @@ -51,8 +66,8 @@ To make the most of your #100DaysOfOSS journey, here are some additional resourc
## Where to Start?
If you're ready to start your #100DaysOfOSS journey, here are some tips to help you get started:
- **Find a Project:** Explore the [OpenSauced](https://opensauced.pizza/) website to find a project that interests you. You can also check out the [weekly post](https://dev.to/bekahhw/series/) for exciting contribution opportunities.
- **Take our Intro To Open Source Course:** If you're new to open source, we recommend taking our [Intro to Open Source](https://github.com/open-sauced/intro) course to learn more about open source and how to get started.
- **Record your journey:** feel free to use our [template repo](https://github.com/open-sauced/100-days-of-oss-template) to write about your journey. Use the [template notion](https://www.notion.so/a0m0rajab/100-Days-Of-Open-Source-2615e66772e14152897002e348c5f1bc?pvs=13).
- **Take our Intro To Open Source Course:** If you're new to open source, we recommend taking our [Intro to Open Source](https://intro.opensauced.pizza/#/) course to learn more about open source and how to get started.
- **Record your journey:** You will learn alot as you navigate this challenge, so we highly recommend using our template repos from [GitHub](https://github.com/open-sauced/100-days-of-oss-template) or [Notion](https://www.notion.so/a0m0rajab/100-Days-Of-Open-Source-2615e66772e14152897002e348c5f1bc?pvs=13) to help you reflect. Remember, this *your* journey, so feel free to customize them how ever you like.

## The Power of the #100DaysOfOSS Challenge
The #100DaysOfOSS challenge offers a supportive community where developers can find encouragement, share experiences, and overcome roadblocks together.
Expand Down Expand Up @@ -84,9 +99,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
19 changes: 19 additions & 0 deletions docs/community/connections.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
id: connections
title: 'Grow your network with our connections feature!'
sidebar_label: 'Connections'
keywords:
- connections
---
## What are Connections?
Connections on OpenSauced serve as a way to build and nurture your professional network within the open source ecosystem. Imagine you're searching for experts in Artificial Intelligence using our "List" feature, and you come across several promising developers. What's next? With Connections, you can now send a request to connect, bringing these experts into your professional circle for easy communication and collaboration.

![connections demo](../../static/gif/connections.gif)

## How Do Connections Work?
- **Sending Connection Requests**: Once you identify users you'd like to connect with, you can send them a connection request.
- **Acceptance**: Upon acceptance of your connection request, both parties become 1st-degree connections.
- **Following Highlights**: After becoming 1st-degree connections, you can follow each other's highlights, keeping up-to-date with accomplishments, contributions, and other notable activities.
- **Contact Information**: Post-acceptance, you'll have access to contact information to foster direct communication and ongoing dialogue.

Excited? Login to [OpenSauced](https://opensauced.pizza/), create your Pro account or use a coupon to get this feature, and start building!😄
14 changes: 14 additions & 0 deletions docs/community/dev-card.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
id: dev-card
title: 'Showcase your open source stats with your dev card'
sidebar_label: 'Dev Card'
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).
![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.

Eager to get your Dev Card? Create it today and share with your network!
Loading

0 comments on commit 34b3769

Please sign in to comment.