diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 00000000..8ad5005f --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,2 @@ +@open-sauced/triage +@open-sauced/docs diff --git a/.github/workflows/compliance.yml b/.github/workflows/compliance.yml index 210504eb..d1d42087 100644 --- a/.github/workflows/compliance.yml +++ b/.github/workflows/compliance.yml @@ -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 diff --git a/.github/workflows/development.yml b/.github/workflows/development.yml index fdb792df..caf73773 100644 --- a/.github/workflows/development.yml +++ b/.github/workflows/development.yml @@ -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 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index dc56036c..72c50a77 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -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 @@ -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 diff --git a/.gitignore b/.gitignore index b2d6de30..2b7b66ca 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ # Misc .DS_Store +.env .env.local .env.development.local .env.test.local @@ -18,3 +19,7 @@ npm-debug.log* yarn-debug.log* yarn-error.log* + + +# custom +config.json diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 00000000..603606bc --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +18.17.0 diff --git a/CHANGELOG.md b/CHANGELOG.md index 64aa76a8..7de980b6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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) diff --git a/Dockerfile b/Dockerfile index 332361d3..4cd0546e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM node:16-alpine as development +FROM node:18.17.0-alpine as development WORKDIR /app diff --git a/README.md b/README.md index c82976e6..0a6951a4 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/community/100-days-of-oss.md b/docs/community/100-days-of-oss.md index ea19d6d3..3d689ec4 100644 --- a/docs/community/100-days-of-oss.md +++ b/docs/community/100-days-of-oss.md @@ -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. @@ -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. @@ -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! diff --git a/docs/community/connections.md b/docs/community/connections.md new file mode 100644 index 00000000..f0896f19 --- /dev/null +++ b/docs/community/connections.md @@ -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!πŸ˜„ diff --git a/docs/community/dev-card.md b/docs/community/dev-card.md new file mode 100644 index 00000000..043157cd --- /dev/null +++ b/docs/community/dev-card.md @@ -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! diff --git a/docs/community/faqs.md b/docs/community/faqs.md index 3862b80d..62fdaf8c 100644 --- a/docs/community/faqs.md +++ b/docs/community/faqs.md @@ -7,9 +7,17 @@ keywords: --- 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). +We believe that [good first issues don't exist](https://opensauced.pizza/blog/good-first-issues-dont-exist), and the best way to find an issue to work on is to create the issue yourself. -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: + However, sites like [good first issues](https://goodfirstissues.com/) and [first timers only](https://www.firsttimersonly.com/) can lead you to projects and issues worth working on. You can also use the `good first issue` label in the search engine of the project you want to contribute to. Check out [this guide](https://www.freecodecamp.org/news/how-to-find-good-first-issues-on-github/) by our Triage Team member, Christine Belzie, to learn more. + + **Additional resources**: + + - ["Who's looking for open source contributors?"](https://dev.to/opensauced/whos-looking-for-open-source-contributors-week-46-247i) + - [Intro to Open Source Course](https://intro.opensauced.pizza/) + +2. **My contribution does not show up on my OpenSauced profile. How do I fix it?** +Create an [insight page](https://intro.opensauced.pizza/#/05-how-to-contribute-to-open-source?id=discovering-open-source-with-opensauced) or adding your merged pull request to [the highlights page](https://intro.opensauced.pizza/#/06-the-secret-sauce?id=develop-your-open-source-resume). + +3. **I want to provide feedback on OpenSauced.** +We love feedback. Post your suggestion in our [feedback repository](https://github.com/orgs/open-sauced/discussions). diff --git a/docs/community/hacktoberfest.md b/docs/community/hacktoberfest.md new file mode 100644 index 00000000..6cb9c49b --- /dev/null +++ b/docs/community/hacktoberfest.md @@ -0,0 +1,45 @@ +--- +id: hacktoberfest +title: 'Join us for Hacktoberfest! πŸŽƒ' +sidebar_label: 'Join us for Hacktoberfest! πŸŽƒ' +keywords: +- hacktoberfest +--- +At OpenSauced, we love open source just as much as pizza! That's why we are participating in Hacktoberfest! πŸŽƒ + +## What is Hacktoberfest? + +From October 1st-31st, people around the globe do a challenge where they submit four pull requests participating projects. Here's how to join: + +1. Go to [the official Hacktoberfest website](https://hacktoberfest.com/) +1. Click on the Register Now! button +1. Sign in with your [GitHub](https://github.com/) and/or [GitLab](https://gitlab.com/users/sign_in) accounts. + +## Why Should I Participate in Hacktoberfest? + +This event is a great way to jumpstart your journey in open source, to meet other people in the tech community, and build your skills. Curious to learn more about the value of contributing to open source? Check out these resources: + +- [Hacktoberfest 2023: Beyond Green Squares](https://dev.to/opensauced/hacktoberfest-2023-beyond-green-squares-4d6j) to learn how to make this a meaningful Hacktoberfest focused on growth, impact, and building relationships. +- [Setting Goals for Your Open Source Contributions](https://dev.to/opensauced/setting-goals-for-your-open-source-contributions-349b) for resources on how to grow your experience through open source. + +## I want to join Hacktoberfest, but I have no idea what open source is + +No problem! πŸ˜„ Here is a list of resources we recommend for first-time contributors: + +- Take our [Intro to Open Source](https://intro.opensauced.pizza/#/) course to learn the history of open source, the tools to succeed in the community, and how to showcase your contributions. +- Check out GitHub's [introductory course](https://github.com/skills/introduction-to-github) to learn how to use the platform when making open source contributions. +- Read our [The Power of Git](https://dev.to/opensauced/the-power-of-git-a-guide-to-collaborative-version-control-dl6) blog post to learn how to harness the power of Git, your trusty weapon in Hacktoberfest. + +## What should I expect during Hacktoberfest? + +During Hacktoberfest, expect to feel excited and a bit competitive on your quest to submit your four pull requests. While those feelings are understandable, it's important to remember the following: + +- Think first, work later: It's best to share your ideas and/or request to work on an issue before submitting a pull request. It'll make it easier for maintainers to assess whether your suggestion fits in with their project. It will also help you develop your communication skills. +- Be patient: Maintainers are people with lives outside of open source, so avoid constantly messaging them about when your pull request be reviewed and merged. +- Try new things: While revising typos is helpful, it's best to diversify contributions. This would help expand your skills, which is very useful if you plan on using your Hacktoberfest contributions as samples for your portfolio. + +## I'm ready for Hacktoberfest + +Great! πŸ˜„ If you're looking for a project to contribute to, check out [this list of beginner-friendly projects for Hacktoberfest](https://insights.opensauced.pizza/pages/BekahHW/655/repositories). + +Happy Contributing! πŸ˜„ diff --git a/docs/community/highlights.md b/docs/community/highlights.md index f3b52db8..91a46d03 100644 --- a/docs/community/highlights.md +++ b/docs/community/highlights.md @@ -1,11 +1,27 @@ --- id: highlights title: 'Highlight your open source contributions' -sidebar_label: 'Highlight your open source contributions' +sidebar_label: 'Highlights' 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 the place 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. + +There are currently three types of highlights you can add to your profile: +- Dev.to blog post +- Pull request +- Issue + +## How to add a highlight +- Go to [OpenSauced's Highlight feed](https://insights.opensauced.pizza/feed). +- Click on the "Post a highlight to show your work!" input. +- Paste the URL to your blog post, pull request, or issue in the bottom input. +- Either use our Auto-Summarize feature or write your own summary. + +![highlights demo](../../static/gif/highlight.gif) + +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://intro.opensauced.pizza/#/06-the-secret-sauce?id=effectively-highlight-your-contributions) in our free "Intro to Open Source" course to learn more. -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. diff --git a/docs/community/hot-opensauced.md b/docs/community/hot-opensauced.md new file mode 100644 index 00000000..1b951567 --- /dev/null +++ b/docs/community/hot-opensauced.md @@ -0,0 +1,21 @@ +--- +id: hot-opensauced +title: Hot OpenSauced Project +sidebar_label: Hot OpenSauced Project +keywords: + - hot OpenSauced project +--- + +[Hot OpenSauced](https://hot.opensauced.pizza/) is a site that helps you discover the hottest open source projects to contribute to. You also have the ability to vote for your favorite open source projects. + +## How to find hot open source projects to contribute to? + +When you visit the [Hot OpenSauced](https://hot.opensauced.pizza/) site, you will see a list of open source projects that are currently trending on GitHub. You can sign in with your GitHub account and search for the most upvoted, recent, and popular projects. + +![hot opensauced upvoted repos](../../static/img/upvoted-repos-hot-opensauced.png) + +## How to vote for your favorite open source projects? + +You can vote for your favorite open source project by clicking on the upvote button. You can view all of your upvoted projects under the My Votes tab. + +![hot opensauced popular repos](../../static/img/popular-repos-hot-opensauced.png) diff --git a/docs/community/insights.md b/docs/community/insights.md new file mode 100644 index 00000000..b2566a1e --- /dev/null +++ b/docs/community/insights.md @@ -0,0 +1,21 @@ +--- +id: insights +title: 'Insights into open source projects' +sidebar_label: 'Insights' +keywords: +- insights +--- +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) + +## 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. diff --git a/docs/community/lists.md b/docs/community/lists.md new file mode 100644 index 00000000..fc92b3db --- /dev/null +++ b/docs/community/lists.md @@ -0,0 +1,22 @@ +--- +id: lists +title: 'Organize and Monitor Your Contributors' +sidebar_label: 'Lists' +keywords: +- lists +--- +The Lists feature enables you to categorize, monitor, and analyze different groups of contributors within your open-source projects. With the Lists feature, gain granular insights into each contributor's activity and contributions. + +Monitor individual commit histories, track who is actively engaged, identify churned or new contributors, and even compare the performance of contributors against each other. This encompasses a wide range of metrics such as code commits, created and reviewed Pull Requests (PRs), as well as issue creation and commenting. + +![lists-page](../../static/img/lists-page.svg) + +## How to Create a List +After logging in, navigate to your [Lists page](https://app.opensauced.pizza/hub/lists/). + +There are two ways to add a list: +1. Explore Contributors: Use our explore tool to find contributors and create your list. +2. Import your GitHub following: +Connect to your GitHub to create a list with all the Contributors you follow + +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. \ No newline at end of file diff --git a/docs/community/pr-velocity.md b/docs/community/pr-velocity.md new file mode 100644 index 00000000..975b3150 --- /dev/null +++ b/docs/community/pr-velocity.md @@ -0,0 +1,11 @@ +--- +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/community/welcome-to-the-community.md b/docs/community/welcome-to-the-community.md index 5ed9ff04..80c00df6 100644 --- a/docs/community/welcome-to-the-community.md +++ b/docs/community/welcome-to-the-community.md @@ -24,11 +24,8 @@ At OpenSauced, we strive to create a welcoming and inclusive community for every The OpenSauced community is a group of open-source enthusiasts who are passionate about making open-source more accessible to everyone. Here are some ways you can keep up with what we're doing: - 🐦 Follow us on Twitter [@SaucedOpen](https://twitter.com/saucedopen) for announcements and our frequent Twitter Spaces. - - Join our [Discord](https://discord.gg/opensauced), and hang out with us in our weekly office hours. - - Subscribe to our [YouTube channel](https://www.youtube.com/@OpenSauced) for the latest updates and video content for OpenSauced. - - πŸ“° Subscribe to our [newsletter](https://news.opensauced.pizza/#/portal/signup) for all things OpenSauced and open source. ## How can I get involved? @@ -40,6 +37,8 @@ You can get involved in the OpenSauced community in a few ways: - Share what you're working on, ask questions, or mentor new contributors in our [Discord](https://discord.gg/opensauced). ## Resources on Getting Started with Open Source +Getting started with open source can be quite daunting for beginners, so we've put together some resources to help you get started. - πŸ“ 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://github.com/open-sauced/intro) to help you get started with open-source. +- πŸ“– 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. \ No newline at end of file diff --git a/docs/contributing/introduction-to-contributing.md b/docs/contributing/introduction-to-contributing.md index dfaa033c..b558f218 100644 --- a/docs/contributing/introduction-to-contributing.md +++ b/docs/contributing/introduction-to-contributing.md @@ -7,22 +7,21 @@ keywords: --- Contributions are always welcome, no matter how large or small. Before contributing, -please read the [code of conduct](./code-of-conduct.md). +please read the [code of conduct](./code-of-conduct.md) and follow the directions below: -Some thoughts to help you contribute to this project +## Recommended Communication Style -## Recommended communication style - -1. Always leave screenshots for visuals changes -1. Always leave a detailed description in the Pull Request. Leave nothing ambiguous for the reviewer. -1. Always review your code first. Do this by leaving comments in your coding noting questions, or interesting things for the reviewer. -1. Always communicate. Whether it is in the issue or the pull request, keeping the lines of communication helps everyone around you. +1. Always leave screenshots for visual changes. +2. Always leave a detailed description in the Pull Request. Leave nothing ambiguous for the reviewer. +3. Always review your code first. Be sure to run the project locally and test before asking for a review. +4. Always communicate in the GitHub repository. Whether it is in the issue or the pull request, keeping the lines of communication open and visible to everyone on the team helps everyone around you. ## Setup -1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) one of the repositories from [github/open-sauced](https://github.com/open-sauced) to your own GitHub account. +1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository you're working on from [github/open-sauced](https://github.com/open-sauced) to your own GitHub account. 2. Clone the forked repository to your local machine. -3. Run `npm ci` to install the dependencies and set up the project. +3. Check the README of the project to determine how to run the project locally. For many of our repositories, you'll find the directions below work for running the project locally. +4. Run `npm ci` to install the dependencies and set up the project. You can also use the shell commands below to get started once you have forked the repository. Make sure to replace `` with your GitHub username. @@ -34,6 +33,7 @@ npm ci ``` ## Building +To generate a production-ready version of your code, run: ```shell npm run build @@ -41,14 +41,14 @@ npm run build ## Testing -For running the test suite, use the following command. Since the tests run in watch mode by default, some users may encounter errors about too many files being open. In this case, it may be beneficial to [install watchman](https://facebook.github.io/watchman/docs/install.html). - +For running the test suite, use the following command: ```shell # the tests will run in watch mode by default npm test ``` +Since the tests run in watch mode by default, some users may encounter errors about too many files being open. In this case, it may be beneficial to [install watchman](https://facebook.github.io/watchman/docs/install.html). -For more info on testing React and JavaScript, check out this course [Testing JavaScript](https://testingjavascript.com/) +For more info on testing React and JavaScript, check out this course [Testing JavaScript](https://testingjavascript.com/). ## Applying Lint Styleguide @@ -68,22 +68,22 @@ npm run format These commands use [ESLint](https://eslint.org/) to check and fix the code. -The automated PR checks will also run these commands, and the PR will be blocked if there are any errors, so it's a good idea to run them before submitting a PR. +If you forget to run this command, automated PR checks will also run these commands, but the PR will be blocked if there are any errors. ## Pull requests **_We actively welcome your pull requests, however linking your work to an existing issue is preferred._** 1. Fork the repo and create your branch from the default branch. -1. Name your branch something that is descriptive to the work you are doing. i.e. adds-new-thing or fixes-mobile -1. If you've added code that should be tested, add tests. -1. If you've changed APIs, update the documentation. -1. If you make visual changes, screenshots are required. -1. Ensure the test suite passes. -1. Make sure you address any lint warnings. -1. If you make the existing code better, please let us know in your PR description. -1. A PR description and title are required. The title is required to begin with: "feat:" or "fix:" -1. [Link to an issue](https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls) in the project. Unsolicited code is welcomed, but an issue is required for an announcement your intentions. PR's without a linked issue will be marked invalid and closed. +2. Name your branch something that is descriptive to the work you are doing. i.e. adds-new-thing or fixes-mobile +3. If you've added code that should be tested, add tests. +4. If you've changed APIs, update the documentation. +5. If you make visual changes, screenshots are required. +6. Ensure the test suite passes. +7. Make sure you address any lint warnings. +8. If you make the existing code better, please let us know in your PR description. +9. A PR description and title are required. The title is required to begin with: "feat:" or "fix:" +10. [Link to an issue](https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls) in the project. Unsolicited code is welcomed, but an issue is required for an announcement your intentions. PR's without a linked issue will be marked invalid and closed. _note for maintainers: All pull requests need a label to assist automation. See the [template](https://github.com/open-sauced/open-sauced/blob/HEAD/.github/release-drafter.yml) to guide which labels to use._ @@ -144,10 +144,10 @@ Do you have questions? Join the conversation in our [Discord](https://discord.gg ## Coding tips - Ask questions if you are stuck. -- Use [CSS variables](https://github.com/open-sauced/open-sauced/blob/HEAD/src/styles/variables.js) +- Use [CSS variables.](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties) - Always use [rel="noreferrer" on all target="\_blank" links](https://web.dev/external-anchors-use-rel-noopener/). ## License By contributing to the OpenSauced project, you agree that your contributions will be licensed -under its [MIT license](https://raw.githubusercontent.com/open-sauced/open-sauced/main/LICENSE). +by a specific License. This information can be found in the `LICENSE` file of the repo you are contributing to. diff --git a/docs/contributing/triage-guide.md b/docs/contributing/triage-guide.md index d79a626f..88c0074d 100644 --- a/docs/contributing/triage-guide.md +++ b/docs/contributing/triage-guide.md @@ -9,7 +9,7 @@ keywords: ## How do I join the triage team? 1. Sign up for [opensauced.pizza](https://opensauced.pizza) -2. Leave a reply in the [invite discussion](https://github.com/open-sauced/open-sauced/discussions/638). +2. Leave a comment in the [discord](https://discord.com/channels/714698561081704529/928693344358514698) channel `open-sauced-contributors-chat`. ## Issue triage process @@ -21,6 +21,7 @@ When a new issue or pull request is opened the issue will be labeled with `needs - `discuss`: Topics for discussion. Might end in an `enhancement` or `question` label. - `bug`: Issues that present a reasonable conviction there is a reproducible bug. - `enhancement`: Issues that are found to be a reasonable candidate feature additions. +- `style`: small css or visual changes. In all cases, issues may be closed by maintainers if they don't receive a timely response when further information is sought, or when additional questions are asked. diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md new file mode 100644 index 00000000..861050f7 --- /dev/null +++ b/docs/maintainers/maintainers-guide.md @@ -0,0 +1,44 @@ +--- +id: maintainers-guide +title: OpenSauced Maintainers Guide +sidebar_label: OpenSauced Maintainers Guide +keywords: + - Maintainers guide +--- + +Welcome to OpenSauced Maintainers Guide for contributors who are interested in being part of the maintainer team for OpenSauced repositories. + +At OpenSauced, we're empowering contributors to work in the open and supporting maintainers to make data-driven decisions for their projects. + +It's important to us that we maintain a healthy environment for contributors and maintainers of our projects. + +## How do I Join the Maintainers Team? +- Sign up for [opensauced.pizza](https://opensauced.pizza/) +- Join our [Discord community](https://discord.gg/opensauced). +- Prove your pizza worth! + +## What does the Maintainers Team do? +Well, like all things in tech, it depends. We have different maintainer teams for each of the repositories, so it's important that you communicate with the admin maintainer if you have any questions. + +### Core Responsibilities +Your responsibilities may include: +- Reviewing and merging pull requests (PRs). +- Providing comments and responses on PRs, issues, discussions, and Discord messages. +- [Triage issues](../contributing/triage-guide.md) and bug reports. +- Maintaining project documentation. +- Collaborating with the community. + +**Think of creating a positive space for contributors at all stages as one of your most important responsibilities.** + +As a maintainer, you must: +- Adhere to our [Code of Conduct](../contributing/code-of-conduct.md) and be an example for treating contributors with respect. +- Communicate with the other maintainers in a timely and reasonable manner. +- Understand and adhere to project standards. + +## Committing and Merging Changes +1. For commit and pull request standards, please refer to [introduction to contributing](../contributing/introduction-to-contributing.md). +2. Before merging in changes, be sure to run the project locally if UI changes were made. +3. **Squash and merge commits** when you merge in a PR. + +Thank you for your interest in becoming a maintainer! Please reach out in our [team discussions](https://github.com/open-sauced/docs/discussions/categories/team-discussions) if you need help, guidance, or clarification at any time. + diff --git a/docs/maintainers/setting-up-a-new-repository.md b/docs/maintainers/setting-up-a-new-repository.md index 86c3f0e7..9d180e8d 100644 --- a/docs/maintainers/setting-up-a-new-repository.md +++ b/docs/maintainers/setting-up-a-new-repository.md @@ -6,11 +6,6 @@ keywords: - setting up a new repository --- -## How do I Join the Maintainers Team? - -1. Sign up for [opensauced.pizza](https://opensauced.pizza) -1. Join [discord](https://discord.gg/gZMKK5q). -1. Prove your pizza worth! ## Requirements @@ -18,7 +13,7 @@ For the purpose of this tutorial, our target demo repository will be called `ope The steps described here mirror [open-sauced/check-engines](https://github.com/open-sauced/check-engines). -The octoherd scripts assume you have exported a programatic token similar to: +The octoherd scripts assume you have exported a programmatic token similar to: ```shell export GH_TOKEN="ghp_Q8TZZT9ypgqw3EeABoCWPcwZBHpjZJ9hI42n" @@ -26,7 +21,7 @@ export GH_TOKEN="ghp_Q8TZZT9ypgqw3EeABoCWPcwZBHpjZJ9hI42n" ## Creating a new repo -Don't spend too much time thinking of a name or a catchy description, just set license to MIT and rocket jump! +Don't spend too much time thinking of a name or a catchy description, just set the license to MIT and rocket jump! ![create a new repository](../../static/img/contributing-maintainers-create-repository.png) @@ -40,11 +35,10 @@ Copy most of the relevant settings with: ```shell npx octoherd-script-sync-repo-settings \ - --template "open-sauced/open-sauced" \ + --template "open-sauced/app" \ -T $GH_TOKEN \ -R "open-sauced/check-engines" ``` - Otherwise you can disable "Projects" and "Wikis" for the selected repository as we are handling them on a larger scale. ## Syncing labels with opensauced.pizza @@ -57,13 +51,16 @@ npx octoherd-script-copy-labels \ -T $GH_TOKEN \ -R "open-sauced/check-engines" ``` - Then go back to your repository and delete: - - documentation - πŸ‘€ needs-triage (green background one) - other potential duplicates if the above race condition is different +> In this context, `race condition` refers to a situation where multiple labels are being deleted simultaneously. This can cause issues if the order in which the labels are deleted affects the final outcome. Therefore, it's important to ensure that the deletion of labels is properly synchronized and controlled to avoid any race conditions. + +In other words, if two of the directories (e.g., `πŸ‘€ needs-triage` and `documentation` are deleted at the same, it is possible that the third directory(`potential duplicates`) will not be deleted. +To avoid the `race condition`, the code must delete the directories in a specific order. For example, it could delete the `documentation directory` first, then the `πŸ‘€ needs-triage` directory, and then the other `potential duplicates` directory. + ## Syncing branch protections with opensauced.pizza This topic is more complex but in a sense tap the main branch and enable @@ -71,9 +68,9 @@ everything except "Restrict who can dismiss pull request reviews" and "Restrict ![maximum merge protections](../../static/img/contributing-maintainers-merge-protections.png) -The "Rules applied to everyone including administrators" is more on an unused override. +The "Rules applied to everyone including administrators" is more of an unused override. -Most of the time this process is super manual but in the limited cases where we need this run: +Most of the time, this process is super manual, but in the limited cases where we need this run: ```shell npx @octoherd/script-sync-branch-protections \ @@ -90,14 +87,14 @@ Pull requests require [triage](https://github.com/open-sauced/open-sauced/blob/m Most `node` projects will require [release automation](https://github.com/open-sauced/open-sauced/blob/main/.github/workflows/release.yml) powered by [@open-sauced/semantic-release-conventional-config](https://github.com/open-sauced/semantic-release-conventional-config). -Other [development workflows](https://github.com/open-sauced/open-sauced/tree/main/.github/workflows) are less common and opinionated towards decentralised collaboration. Use these as example backbones for your new repository. +Other [development workflows](https://github.com/open-sauced/open-sauced/tree/main/.github/workflows) are less common and opinionated towards decentralized collaboration. Use these as examples of backbones for your new repository. ## Setting up environments and secrets -As you may have noticed in the previous step or in the actions visualisations, the release workflows enable named environments. +As you may have noticed in the previous step or in the action visualizations, the release workflows enable named environments. These have to be manually set up, along with their secrets and branch protections. ![create environment](../../static/img/contributing-maintainers-env.png) -If using `npm` or `ghcr` it is likely you will add a couple variables here. +If using `npm` or `ghcr`, it is likely you will add a couple of variables here. diff --git a/docs/technical/introduction-to-storybook.md b/docs/technical/introduction-to-storybook.md index f7c58f65..f9607517 100644 --- a/docs/technical/introduction-to-storybook.md +++ b/docs/technical/introduction-to-storybook.md @@ -5,7 +5,7 @@ sidebar_label: Introduction to storybook keywords: - Introduction to storybook --- - +Storybook is an open-source tool that helps developers build, test, and document UI components in isolation. Storybook is being leveraged to mock out visual React components. The latest version of the design system can be found at this [URL](https://sauced-components.netlify.app/). To run storybook, use this command: @@ -20,34 +20,34 @@ Storybook is broken into several categories: ## Making changes to storybook -This section details how to make changes to Storybook, mainly creating new categories or UI elements. - -## Adding a new category +This section details how to make changes to Storybook, mainly by creating new categories or UI elements. -To add a new category, a new file needs to be added to `/stories`. Please follow the naming convention of `*Previous File Number + 1*-*Name of Story Capitalized*-stories.js` when creating a new file. In the file ensure you have this code in the file: +### Adding a new category +To add a new category, a new file needs to be added to the `/stories` directory. When creating a new file, the filename should be named using the following convention: ```*Previous File Number + 1*-*Name of Story Capitalized*-stories.js```. For example, if the last file was 2-SideBar-stories.js, then the new file should be named ```3-NameOfYourFile-stories.js```. +In the file ensure you have this code: ``` export default { title: "*Name of category*" }; ``` -## Adding a new UI element +### Adding a new UI element -To add a new UI element to to an existing category, add the following code to that category's file: +To add a new UI element to an existing category, add the following code to that category's file: ``` export const *Name of UI Element* = () => ( - +// code for the new element ); ``` diff --git a/docs/technical/resolve-merge-conflicts.md b/docs/technical/resolve-merge-conflicts.md index 0f6bd9c1..94a0b15a 100644 --- a/docs/technical/resolve-merge-conflicts.md +++ b/docs/technical/resolve-merge-conflicts.md @@ -6,7 +6,7 @@ keywords: - Resolve merge conflicts --- -Pretty often when opening a pull request it is very likely to run into merge conflicts as the release process is generally updating `npm-shriknwrap.json`. +Pretty often when opening a pull request it is very likely to run into merge conflicts as the release process is generally updating `npm-shrinkwrap.json`. To better illustrate the commands listed here at will use commits and screenshots from [open-sauced#1078](https://github.com/open-sauced/open-sauced/pull/1078). @@ -14,7 +14,8 @@ In literally every case it is advised _**not**_ to use the `Resolve conflicts` b ![don't resolve conflicts like this](../../static/img/contributing-resolve-merge-conflicts-dont-do.png) -The above will at best achieve a ready to merge pull request with visible inconsistencies. +The above will at best achieve a ready-to-merge pull request with visible inconsistencies. + ## Repository setup @@ -46,7 +47,7 @@ origin git@github.com:0-vortex/open-sauced.git (fetch) origin git@github.com:0-vortex/open-sauced.git (push) ``` -As an additional step for this tutorial we need to add the `upstream` remote: +As an additional step for this tutorial, we need to add the `upstream` remote: ```shell git remote add upstream git@github.com:open-sauced/open-sauced.git @@ -54,8 +55,7 @@ git remote add upstream git@github.com:open-sauced/open-sauced.git ## Update -First get the default branch changes: - +First, get the default branch changes: ```shell git fetch origin --recurse-submodules=no --progress --prune @@ -68,7 +68,6 @@ git merge upstream/main --no-stat -v Then merge with the forked up-to-date `beta` (default branch): - ```shell git merge origin/main --no-ff -v ``` @@ -91,8 +90,7 @@ It will look like this: ## Resolve conflicts -Since this pull request does not modify the `package.json` file it is safe to fast forward the changes from `origin/main`: - +Since this pull request does not modify the `package.json` file it is safe to fast-forward the changes from `origin/main`: ```shell # overwrite with origin/main changes @@ -140,7 +138,7 @@ It should look something like this: The result of the above commands can be viewed at [283ff8cd788c550309ff0d1d5a9a5a97ec0731b2](https://github.com/open-sauced/open-sauced/pull/1078/commits/283ff8cd788c550309ff0d1d5a9a5a97ec0731b2) -GitHub will conveniently display only you merge conflict changes: +GitHub will conveniently display only your merge conflict changes: ![view merge commit](../../static/img/contributing-resolve-merge-conflicts-view-merge-commit.png) @@ -150,14 +148,15 @@ And it's ready to merge: ## Dependency updates -When dealing with dependency and lock file updates there are multiple use cases to consider, however as a baseline, the OpenSauced triage team will not prioritize parallel main features as seen in the roadmap. +When dealing with dependency and lock file updates, there are multiple use cases to consider; however, as a baseline, the OpenSauced triage team will not prioritize parallel main features as seen in the roadmap. However when that happens, it is advised to: -- fast-forward `npm-shrinkwrap.json` -- fast-forward deleted and modified `upstream/beta` changes to `package.json` + +- fast-forward `npm-shrinkwrap.json` +- fast-forward deleted and modified `upstream/beta` changes to `package.json` - fast-forward your added lines to `package.json` - run `npm ci` to delete local modules and create dependency resolution from `upstream/beta` -Visual diffing is advised however not following the git commit history procedure will result in a rogue pull request that scope creeps into dependency updates. +Visual diffing is advised; however, not following the git commit history procedure will result in a rogue pull request that creeps into dependency updates. -Generally speaking, just adding things to a lockfile will not be troublesome and since this is a licensed project, we should be careful when adding dependencies. +Generally speaking, just adding things to a lock file will not be troublesome, and since this is a licensed project, we should be careful when adding dependencies. diff --git a/docs/technical/setup-repo-with-git.md b/docs/technical/setup-repo-with-git.md new file mode 100644 index 00000000..ccee802f --- /dev/null +++ b/docs/technical/setup-repo-with-git.md @@ -0,0 +1,70 @@ +--- +id: setup-repo-with-git +title: Setting up a repository with Git and GitHub +sidebar_label: Setting up a repository with Git and GitHub +keywords: + - Setting up a repository with Git and GitHub +--- + +## Using the GitHub CLI + +### How to install the GitHub CLI + +The [GitHub CLI](https://cli.github.com/) allows you to fork repositories, create issues, pull requests, and more from the command line. + +The GitHub CLI can be installed on Mac, Windows or Linux. You can find the complete installation instructions [here](https://github.com/cli/cli#installation). + +### How to authenticate with the GitHub CLI + +From the terminal, you will need to authenticate with the GitHub CLI. You can do this by running the following command: + +```shell +gh auth login +``` + +Follow the on screen prompts to authenticate with the GitHub CLI. + +### How to fork and clone a repository with the GitHub CLI + +A fork is a copy of a repository and it allows you to freely experiment with changes without affecting the original project. + +A clone is a local copy of a repository that includes all the files, branches, and commits. + +To fork and clone a repository with the GitHub CLI, run the following command: + +```shell +gh repo fork open-sauced/REPO_NAME +``` + +The GitHub CLI will fork the project in your GitHub account and will ask you if you want to clone the repository on your local machine. + +### How to view the remote repositories locally + +To view the remote repositories that your local repository is connected to, run the following command: + +```shell +git remote -v +``` + +You should see the following output: + +```shell +origin git@github.com:YOUR_GITHUB_USERNAME/open-sauced.git (fetch) +origin git@github.com:YOUR_GITHUB_USERNAME/open-sauced.git (push) +upstream git@github.com:open-sauced/open-sauced.git (fetch) +upstream git@github.com:open-sauced/open-sauced.git (push) +``` + +### How to add a remote repository + +To pull in changes from the original repository, you will need to add a remote repository. To do this, run the following command: + +```shell +git remote add upstream git@github.com:open-sauced/open-sauced.git +``` + +This will allow you to pull in changes from the original repository and keep your forked copy of the repository up to date. + +## Using the GitHub website and the command line + +If you prefer to setup your repository using the GitHub website and the command line, then you can follow this detailed guide from the [official GitHub documentation](https://docs.github.com/en/get-started/quickstart/fork-a-repo). diff --git a/docusaurus.config.js b/docusaurus.config.js index 1e2d1f9b..7a386574 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,121 +1,121 @@ -const lightCodeTheme = require('prism-react-renderer/themes/github'); -const darkCodeTheme = require('prism-react-renderer/themes/dracula'); +const lightCodeTheme = require("prism-react-renderer/themes/github"); +const darkCodeTheme = require("prism-react-renderer/themes/dracula"); /** @type {import('@docusaurus/types').DocusaurusConfig} */ module.exports = { - title: 'OpenSauced', - tagline: 'The path to your next Open Source contribution', - url: 'https://docs.opensauced.pizza', - baseUrl: '/', - onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', - favicon: 'img/favicon.ico', - organizationName: 'open-sauced', // Usually your GitHub org/user name. - projectName: 'docs.opensauced.pizza', // Usually your repo name. + title: "OpenSauced", + tagline: "The path to your next Open Source contribution", + url: "https://docs.opensauced.pizza", + baseUrl: "/", + onBrokenLinks: "throw", + onBrokenMarkdownLinks: "warn", + favicon: "img/favicon.ico", + organizationName: "open-sauced", // Usually your GitHub org/user name. + projectName: "docs.opensauced.pizza", // Usually your repo name. trailingSlash: true, themeConfig: { algolia: { - appId: 'bh4d9od16a', - apiKey: '1691a4a5b06166984397aa30153f663c', - indexName: 'opensauced', - algoliaOptions: { 'facetFilters': ["type:$TYPE"] }, + appId: "RH1WG3CUDK", + apiKey: "ea723aba7d69f2f36feac9292f2d2fe9", + indexName: "dev_docs_index", + algoliaOptions: { facetFilters: ["type:$TYPE"] }, debug: false, - placeholder: 'Search OpenSauced Docs', + placeholder: "Search OpenSauced Docs", }, navbar: { logo: { - alt: 'OpenSauced Logo', - src: 'img/logo_lightmode.png', - srcDark: 'img/logo_darkmode.png', - href: 'https://opensauced.pizza/' + alt: "OpenSauced Logo", + src: "img/logo_lightmode.png", + srcDark: "img/logo_darkmode.png", + href: "https://opensauced.pizza/", }, items: [ { - type: 'doc', - docId: 'introduction', - label: 'Docs', - position: 'left', + type: "doc", + docId: "introduction", + label: "Docs", + position: "left", }, { - alt: 'OpenSauced Logo', - src: 'img/logo.svg', - href: 'https://opensauced.pizza/' + alt: "OpenSauced Logo", + src: "img/logo.svg", + href: "https://opensauced.pizza/", }, { - href: 'https://dev.to/opensauced', - label: 'Blog', - position: 'left', + href: "https://dev.to/opensauced", + label: "Blog", + position: "left", }, { - href: 'https://github.com/open-sauced/docs.opensauced.pizza', - label: 'GitHub', - position: 'left', + href: "https://github.com/open-sauced/docs.opensauced.pizza", + label: "GitHub", + position: "left", }, { - href: 'https://discord.gg/U2peSNf23P', - label: 'Discord', - position: 'left', + href: "https://discord.gg/U2peSNf23P", + label: "Discord", + position: "left", }, { - href: 'https://opensauced.pizza/', - label: 'OpenSauced', - position: 'right', + href: "https://opensauced.pizza/", + label: "OpenSauced", + position: "right", }, ], }, colorMode: { - defaultMode: 'light', + defaultMode: "light", disableSwitch: false, respectPrefersColorScheme: false, }, footer: { logo: { - alt: 'OpenSauced Logo', - src: 'img/logo.svg', - href: 'https://opensauced.pizza/' + alt: "OpenSauced Logo", + src: "img/logo.svg", + href: "https://opensauced.pizza/", }, - style: 'dark', + style: "dark", links: [ { - title: 'Docs', + title: "Docs", items: [ { - label: 'Contributing guide', - to: '/contributing/introduction-to-contributing/', + label: "Contributing guide", + to: "/contributing/introduction-to-contributing/", }, { - label: 'Maintainer guide', - to: '/maintainers/setting-up-a-new-repository/', + label: "Maintainer guide", + to: "/maintainers/setting-up-a-new-repository/", }, { - label: 'Chrome Extension Usage', - to: '/chrome-extension/introduction-to-the-chrome-extension/', - } + label: "Chrome Extension Usage", + to: "/chrome-extension/introduction-to-the-chrome-extension/", + }, ], }, { - title: 'Community', + title: "Community", items: [ { - label: 'GitHub', - href: 'https://github.com/open-sauced/open-sauced/discussions', + label: "GitHub", + href: "https://github.com/orgs/open-sauced/discussions", }, { - label: 'Discord', - href: 'https://discord.com/invite/U2peSNf23P', + label: "Discord", + href: "https://discord.com/invite/U2peSNf23P", }, { - label: 'Twitter', - href: 'https://twitter.com/saucedopen', - } + label: "Twitter", + href: "https://twitter.com/saucedopen", + }, ], }, { - title: 'More', + title: "More", items: [ { - label: 'Blog', - href: 'https://dev.to/opensauced', + label: "Blog", + href: "https://dev.to/opensauced", }, { label: 'Download book', @@ -133,23 +133,22 @@ module.exports = { }, presets: [ [ - '@docusaurus/preset-classic', + "@docusaurus/preset-classic", { docs: { - routeBasePath: '/', - sidebarPath: require.resolve('./sidebars.js'), + routeBasePath: "/", + sidebarPath: require.resolve("./sidebars.js"), // Please change this to your repo. - editUrl: - 'https://github.com/open-sauced/docs.opensauced.pizza/edit/main/', - lastVersion: 'current', + editUrl: "https://github.com/open-sauced/docs.opensauced.pizza/edit/main/", + lastVersion: "current", showLastUpdateAuthor: true, showLastUpdateTime: true, }, theme: { - customCss: require.resolve('./src/css/custom.css'), + customCss: require.resolve("./src/css/custom.css"), }, sitemap: { - changefreq: 'weekly', + changefreq: "weekly", priority: 0.5, }, }, @@ -157,60 +156,56 @@ module.exports = { ], plugins: [ [ - '@docusaurus/plugin-pwa', + "@docusaurus/plugin-pwa", { debug: true, - offlineModeActivationStrategies: [ - 'appInstalled', - 'standalone', - 'queryString', - ], + offlineModeActivationStrategies: ["appInstalled", "standalone", "queryString"], pwaHead: [ { - tagName: 'link', - rel: 'icon', - href: '/img/logo.svg', + tagName: "link", + rel: "icon", + href: "/img/logo.svg", }, { - tagName: 'link', - rel: 'manifest', - href: '/manifest.json', // your PWA manifest + tagName: "link", + rel: "manifest", + href: "/manifest.json", // your PWA manifest }, { - tagName: 'meta', - name: 'theme-color', - content: '#313d3e', + tagName: "meta", + name: "theme-color", + content: "#313d3e", }, { - tagName: 'meta', - name: 'apple-mobile-web-app-capable', - content: 'yes', + tagName: "meta", + name: "apple-mobile-web-app-capable", + content: "yes", }, { - tagName: 'meta', - name: 'apple-mobile-web-app-status-bar-style', - content: '#000', + tagName: "meta", + name: "apple-mobile-web-app-status-bar-style", + content: "#000", }, { - tagName: 'link', - rel: 'apple-touch-icon', - href: '/apple-touch-icon.png', + tagName: "link", + rel: "apple-touch-icon", + href: "/apple-touch-icon.png", }, { - tagName: 'link', - rel: 'mask-icon', - href: '/img/logo.svg', - color: 'rgb(37, 194, 160)', + tagName: "link", + rel: "mask-icon", + href: "/img/logo.svg", + color: "rgb(37, 194, 160)", }, { - tagName: 'meta', - name: 'msapplication-TileImage', - content: '/img/logo.svg', + tagName: "meta", + name: "msapplication-TileImage", + content: "/img/logo.svg", }, { - tagName: 'meta', - name: 'msapplication-TileColor', - content: '#000', + tagName: "meta", + name: "msapplication-TileColor", + content: "#000", }, ], }, diff --git a/introduction.md b/introduction.md deleted file mode 100644 index e69de29b..00000000 diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json index fb856ccd..de5d07fa 100644 --- a/npm-shrinkwrap.json +++ b/npm-shrinkwrap.json @@ -1,12 +1,12 @@ { "name": "@open-sauced/docs.opensauced.pizza", - "version": "1.37.0", + "version": "1.49.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@open-sauced/docs.opensauced.pizza", - "version": "1.37.0", + "version": "1.49.0", "hasInstallScript": true, "dependencies": { "@docusaurus/core": "2.4.0", @@ -28,8 +28,8 @@ "url-loader": "^4.1.1" }, "engines": { - "node": ">=14", - "npm": ">=7" + "node": "^18", + "npm": ">=9" } }, "node_modules/@algolia/autocomplete-core": { diff --git a/package.json b/package.json index 05c57848..a07c7800 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,10 @@ { "name": "@open-sauced/docs.opensauced.pizza", - "version": "1.37.0", + "version": "1.49.0", "private": true, "engines": { - "node": ">=14", - "npm": ">=7" + "node": "^18", + "npm": ">=9" }, "scripts": { "preinstall": "npx @open-sauced/check-engines", diff --git a/sidebars.js b/sidebars.js index 26d3a234..9eb4fba1 100644 --- a/sidebars.js +++ b/sidebars.js @@ -18,9 +18,15 @@ module.exports = { collapsed: false, items: [ "community/welcome-to-the-community", - "community/highlights", "community/100-days-of-oss", + "community/highlights", + "community/insights", "community/faqs", + "community/dev-card", + "community/hacktoberfest", + "community/lists", + "community/connections", + "community/hot-opensauced", ], }, { @@ -38,13 +44,18 @@ module.exports = { type: "category", label: "Technical guide", collapsed: false, - items: ["technical/introduction-to-storybook", "technical/resolve-merge-conflicts"], + items: [ + "technical/introduction-to-storybook", + "technical/setup-repo-with-git", + "technical/resolve-merge-conflicts", + ], }, { type: "category", label: `Maintainer guide`, collapsed: true, items: [ + "maintainers/maintainers-guide", "maintainers/setting-up-a-new-repository", "maintainers/check-engines", "maintainers/conventional-commit", diff --git a/static/gif/connections.gif b/static/gif/connections.gif new file mode 100644 index 00000000..dc032692 Binary files /dev/null and b/static/gif/connections.gif differ diff --git a/static/gif/highlight.gif b/static/gif/highlight.gif new file mode 100644 index 00000000..c76a5abb Binary files /dev/null and b/static/gif/highlight.gif differ diff --git a/static/gif/insight-page-demo.gif b/static/gif/insight-page-demo.gif new file mode 100644 index 00000000..3bdd7d28 Binary files /dev/null and b/static/gif/insight-page-demo.gif differ diff --git a/static/img/a-dev-card.png b/static/img/a-dev-card.png new file mode 100644 index 00000000..1411a7a4 Binary files /dev/null and b/static/img/a-dev-card.png differ diff --git a/static/img/lists-page.svg b/static/img/lists-page.svg new file mode 100644 index 00000000..e3202975 --- /dev/null +++ b/static/img/lists-page.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/static/img/popular-repos-hot-opensauced.png b/static/img/popular-repos-hot-opensauced.png new file mode 100644 index 00000000..60ff9575 Binary files /dev/null and b/static/img/popular-repos-hot-opensauced.png differ diff --git a/static/img/pr-velocity-example.png b/static/img/pr-velocity-example.png new file mode 100644 index 00000000..ee78cfd2 Binary files /dev/null and b/static/img/pr-velocity-example.png differ diff --git a/static/img/upvoted-repos-hot-opensauced.png b/static/img/upvoted-repos-hot-opensauced.png new file mode 100644 index 00000000..a059a30f Binary files /dev/null and b/static/img/upvoted-repos-hot-opensauced.png differ