Skip to content

Commit 411bff9

Browse files
authored
Merge branch 'open-sauced:main' into main
2 parents a0f30ce + 2f2a73c commit 411bff9

40 files changed

+334
-11
lines changed

CHANGELOG.md

+14
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,20 @@
55

66
> All notable changes to this project will be documented in this file
77
8+
## [1.60.0](https://github.com/open-sauced/docs/compare/v1.59.0...v1.60.0) (2024-01-05)
9+
10+
11+
### Features
12+
13+
* Adds image and instructions on how to get DevCard page ([#234](https://github.com/open-sauced/docs/issues/234)) ([b358c27](https://github.com/open-sauced/docs/commit/b358c277eaf1de543f066e2143eae048344026f1))
14+
15+
## [1.59.0](https://github.com/open-sauced/docs/compare/v1.58.0...v1.59.0) (2024-01-04)
16+
17+
18+
### Features
19+
20+
* Adds info on adding teammates to the insights page ([#230](https://github.com/open-sauced/docs/issues/230)) ([d6b4681](https://github.com/open-sauced/docs/commit/d6b46819d72515b17222ad23c080578be308bf39))
21+
822
## [1.58.0](https://github.com/open-sauced/docs/compare/v1.57.1...v1.58.0) (2023-12-14)
923

1024

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 OpenSauced
3+
Copyright (c) 2024 OpenSauced
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

docs/community/100-days-of-oss.md

+6
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ title: "#100DaysOfOSS: Growing Skills and Real-World Experience"
44
sidebar_label: "#100DaysOfOSS"
55
keywords:
66
- "100 days of open source"
7+
- "100 days of OSS"
8+
- "Open source contribution"
9+
- "Open source software development"
10+
- "Open source projects for beginners"
11+
- "Open source development"
12+
713
---
814

915
Inspired by the great work of the [#100DaysOfCode challenge](https://www.100daysofcode.com/), we're starting #100DaysOfOSS.

docs/community/hacktoberfest.md

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ title: "Join us for Hacktoberfest! 🎃"
44
sidebar_label: "Join us for Hacktoberfest! 🎃"
55
keywords:
66
- "hacktoberfest"
7+
- "Open source contributions for Hacktoberfest"
8+
- "Hacktoberfest participation guide"
9+
- "Open source collaboration in October"
10+
- "Hacktoberfest beginner-friendly projects"
11+
- "How to get involved in Hacktoberfest"
712
---
813

914
At OpenSauced, we love open source just as much as pizza! That's why we are participating in Hacktoberfest! 🎃

docs/community/welcome-to-the-community.md

+4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ title: "Welcome to the OpenSauced Community"
44
sidebar_label: "Welcome to the Community"
55
keywords:
66
- "welcome to the community"
7+
- "The community welcomes you"
8+
- "Get involved in the community"
9+
- "Join our community"
10+
- "Greetings from the community"
711
---
812

913
Welcome to the OpenSauced community! At OpenSauced, we strive to bring collaboration and inspiration to every open source contributor and help build a global community of open source developers, empowering you to grow, innovate, and achieve greatness in the open.

docs/contributing/code-of-conduct.md

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ title: "Code of Conduct"
44
sidebar_label: "Code of Conduct"
55
keywords:
66
- "code of conduct"
7+
- "Community guidelines"
8+
- "Guidelines for behavior"
9+
- "Interaction guidelines"
10+
- "rules and guidelines"
11+
- "Behavioral expectations"
712
---
813

914
## Our Pledge

docs/contributing/introduction-to-contributing.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ title: "Introduction to Contributing"
44
sidebar_label: "Introduction to Contributing"
55
keywords:
66
- "introduction to contributing"
7+
- "Getting started with contributions"
8+
- "New contributor guide"
9+
- "How to contribute effectively"
10+
- "Contribution essentials"
11+
- "Open source contribution guide"
12+
- "Making your first contribution"
13+
- "Beginner-friendly contributions"
14+
- "Contributing to open source projects"
15+
- "Starting your contribution journey"
16+
- "First-time contributor tips"
717
---
818

919
Contributions are always welcome, no matter how large or small. Before contributing,
@@ -20,7 +30,7 @@ please read the [code of conduct](./code-of-conduct.md) and follow the direction
2030

2131
If you wish to work on an open issue, please comment on the issue with `.take`, and it will be assigned to you. If an issue is not assigned, it is assumed to be available for anyone to work on. Please assign yourself to an issue before working on it to avoid conflicts.
2232

23-
If you contribute to the project for the first time, you can search for issues with `good first issue` or `bug` labels in the repository.
33+
If you contribute to the project for the first time, you can search for issues with `good first issue` or `bug` labels in the repository. Please only self-assign a `good first issue` one time.
2434

2535
In case you get stuck, feel free to ask for help in the [Discord](https://discord.gg/U2peSNf23P) server or [GitHub Discussions](https://github.com/orgs/open-sauced/discussions).
2636

@@ -57,6 +67,9 @@ See [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for m
5767
- The title must begin with "feat:", "fix:", or anything related to your changes. <br /> **Tips**: You can follow your chosen option when [committing](#commits) your changes.
5868

5969
- Unsolicited code is welcomed, but an issue is required to announce your intentions. <br /> **_PRs without a linked issue will be marked invalid and closed_**.
70+
71+
> [!IMPORTANT]
72+
> Please do not DM Maintainers or contact them outside of GitHub if you want a PR Review. If you haven't received a review within a week, please tag them in the PR comments to ask for an estimated time of review.
6073
6174
> _**Note for maintainers**: All PRs need a label to assist automation. See [this guide](./triage-guide.md#adding-issue-and-pr-labels) to determine which labels to use._
6275

docs/contributing/maintainers-guide.md

+4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ title: "OpenSauced Maintainers Guide"
44
sidebar_label: "OpenSauced Maintainers Guide"
55
keywords:
66
- "maintainers guide"
7+
- "open source maintainers guide"
8+
- "open source maintainer"
9+
- "open-source project management"
10+
- "community management in open-source"
711
---
812

913
Welcome to the OpenSauced Maintainers Guide for contributors who are interested in being part of the maintainer team for OpenSauced repositories.

docs/contributing/set-up-authentication.md

+9
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ title: "Set Up Authentication"
44
sidebar_label: "Set Up Authentication"
55
keywords:
66
- "set up authentication"
7+
- "Authentication setup guide"
8+
- "Setting up secure login"
9+
- "User authentication configuration"
10+
- "Authentication system setup"
11+
- "Authentication implementation steps"
12+
- "Authentication setup tutorial"
13+
- "Setting up user authorization"
14+
- "Step-by-step authentication setup"
15+
- "Authentication best practices"
716
---
817

918
You need to obtain an authentication token to interact with the OpenSauced public API as an authenticated user.

docs/contributing/technical/resolve-merge-conflicts.md

+13
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,19 @@ title: "Resolve Merge Conflicts"
44
sidebar_label: "Resolve Merge Conflicts"
55
keywords:
66
- "resolve merge conflicts"
7+
- "merge-conflict"
8+
- "solve merge conflicts"
9+
- "Git merge conflict"
10+
- "Merge conflict resolution"
11+
- "Merge conflict prevention"
12+
- "Merge conflict handling"
13+
- "Merge conflict management"
14+
- "Merge conflict avoidance"
15+
- "Merge conflict workflow"
16+
- "Merge conflict strategies"
17+
- "Merge conflict best practices"
18+
- "Merge conflict tools"
19+
720
---
821

922
When you are working on any of the OpenSauced repositories, you might run into a merge conflict. A merge conflict occurs when multiple conflicting changes are made to the same line in a file. Merge conflicts happen the most when you open a pull request, as the release process generally updates `npm-shrinkwrap.json`.

docs/contributing/technical/setup-repo-with-git.md

+10
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,18 @@ title: "Setting Up a Repository with Git and GitHub"
44
sidebar_label: "Setting Up a Repository with Git and GitHub"
55
keywords:
66
- "setting up a repository with Git and GitHub"
7+
- "working with git and github"
8+
- "GitHub repository creation"
9+
- "GitHub repository workflow"
10+
- "GitHub repository initialization"
11+
- "GitHub repository hosting"
12+
- "GitHub repository collaboration"
13+
- "GitHub repository version control"
14+
- "GitHub repository deployment"
15+
- "GitHub repository setup"
716
---
817

18+
919
## Using the GitHub CLI
1020

1121
### How to Install the GitHub CLI

docs/contributing/triage-guide.md

+10
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ title: "Triage Guide"
44
sidebar_label: "Triage Guide"
55
keywords:
66
- "triage guide"
7+
- "Issue triage best practices"
8+
- "GitHub triage process"
9+
- "Pull request triage steps"
10+
- "Triage workflow tutorial"
11+
- "Effective issue management"
12+
- "Open source contribution triage"
13+
- "Triage for project maintainers"
14+
- "Streamlining triage efforts"
15+
- "Collaborative issue handling"
16+
- "Contributor triage assistance"
717
---
818

919
## How to Join the Triage Team

docs/features/connections.md

+10
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ title: "Grow Your Network with Our Connections Feature!"
44
sidebar_label: "Connections"
55
keywords:
66
- "connections"
7+
- "Network connections"
8+
- "Professional connections"
9+
- "Building connections"
10+
- "Online connections"
11+
- "Networking opportunities"
12+
- "tech connections"
13+
- "grow newtwork"
14+
- "grow connection"
15+
- "Community connections"
16+
717
---
818

919
## What are Connections?

docs/features/dev-card.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ title: "Showcase Your Open Source Stats with Your Dev Card"
44
sidebar_label: "Dev Card"
55
keywords:
66
- "dev card"
7+
- "DevCard"
8+
- "OpenSource"
9+
- "Open Source DevCard"
10+
- "Showcase DevCard"
11+
- "Showcase Your Open Source Stats"
12+
- "Open Source Stats DevCard"
13+
714
---
815

916
The Dev Card feature is what we like to call your "open source business card."
@@ -16,4 +23,10 @@ You'll see the back side of your card when you click it. It shows more informati
1623

1724
Whether you are just beginning your open source journey or a maintainer looking for more contributors and sponsors, you can share your Dev Card as a snapshot of your contributions, skills, and engagement in the open source community.
1825

19-
Eager to get your Dev Card? Create it today and share it with your network!
26+
Eager to get your Dev Card? Here's how you can get yours today:
27+
28+
1. Log in to your OpenSauced account.
29+
2. Navigate to your [profile](https://app.opensauced.pizza/user/{username}).
30+
3. Click the Dev Card icon on your profile image.
31+
32+
![dev card icon on user profile](../../static/img/get-dev-card.png)

docs/features/highlights.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@ id: highlights
33
title: "Highlight Your Open Source Contributions"
44
sidebar_label: "Highlights"
55
keywords:
6-
- "highlights"
6+
- "Highlights"
7+
- "Open Source Highlights"
8+
- "Contribution Highlights"
9+
- "Highlight your open source contributiions"
10+
- "Open Source Contribution Highlights"
711
---
812

913
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 and the issues that need support and attract new contributors.

docs/features/insights.md

+40-1
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,15 @@ title: "Insights into Open Source Projects"
44
sidebar_label: "Insights"
55
keywords:
66
- "insights"
7+
- "open source"
8+
- "projects"
9+
- "Open Source Insights"
10+
- "Project Insights"
11+
- "Insights into Open Source Projects"
12+
- "Open Source Project Insights"
713
---
814

9-
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.
15+
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.
1016

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

@@ -25,3 +31,36 @@ The Insights feature is your one-stop solution for understanding the pulse of yo
2531
- Find new contributors to support your project.
2632

2733
To learn more about how to use Insights, check out our [Maintainers Guide](../maintainers/maintainers-guide.md) and our [Understanding Insights Data](../maintainers/understanding-insights.md) pages.
34+
35+
## Sharing Your Insights Page with Your Team
36+
37+
After you've created your Insights Page, share it with your team.
38+
39+
Sharing this page with your team ensures that everyone is well-informed about the project's status and can collaborate more effectively. It fosters a collaborative environment where team members can align their efforts, make informed decisions, and collectively work toward the organization's success.
40+
41+
### How to Share Insights Page
42+
43+
There are two methods to share your Insights Page:
44+
45+
#### Method 1: Using the Share Button
46+
47+
This method gives view-only access to your Insights Page.
48+
49+
1. Click the "Insights" tab at the top bar.
50+
2. Click the page that you want to share.
51+
3. On the top right, click the "Share" button to copy the Insights Page URL to the clipboard.
52+
4. Share the URL with your team members.
53+
54+
#### Method 2: Adding a Team Member
55+
56+
This method allows you to invite your team members to your Insights Page and offers you options to permit them to be an admin of the page, edit or view the page, or remove them from it.
57+
58+
1. Click the "Insights" tab at the top bar.
59+
2. Click the page that you want to share.
60+
3. Click the "Edit Page" button on the top right.
61+
4. Scroll down to the "Add Team Members" section.
62+
5. Enter the email address of the team member you want to invite.
63+
6. Click the "Send invite" button. <br/> Once you click the button, your team member's email will be listed at the bottom.
64+
7. To select and give permission to your team member, click the arrow button on the right side of their email.
65+
66+
To learn more about inviting your team, check out [this tutorial video](https://www.youtube.com/watch?v=L5ztLP1O7BY).

docs/features/lists.md

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ title: "Organize and Monitor Your Contributors"
44
sidebar_label: "Lists"
55
keywords:
66
- "lists"
7+
- "contributors"
8+
- "organize"
9+
- "Monitor Contributors"
10+
- "Organize Contributors"
11+
- "Contributor Lists Management"
712
---
813

914
The Lists feature enables you to categorize, monitor, and analyze different groups of contributors within open source projects. With the Lists feature, gain granular insights into each contributor's activity and contributions.

docs/introduction.md

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ title: "Introduction to OpenSauced 🍕"
44
sidebar_label: "Introduction to OpenSauced 🍕"
55
keywords:
66
- "introduction"
7+
- "introduction to opensauced"
8+
- "opensauced introduction"
9+
- "get to know opensauced"
710
---
811

912
![Example banner](../static/img/what-is-opensauced-borderless.jpg)

docs/job-seekers-guide/categorize-contributions.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,15 @@ id: how-to-translate-open-source-contributions-into-career-opportunities
33
title: "How to Translate Open Source Contributions into Career Opportunities"
44
sidebar_label: "How to Translate Open Source Contributions into Career Opportunities"
55
keywords:
6-
- how-to-translate-open-source-contributions-into-career-opportunities
6+
- "how-to-translate-open-source-contributions-into-career-opportunities"
7+
- "how to get a job with open source contributions"
8+
- "benefits of open source contributions for career development"
9+
- "open source projects to boost your resume"
10+
- "how to showcase your open source work to employers"
11+
- "open source skills that employers look for"
12+
- "how to find open source opportunities in your field"
13+
- "best practices for open source contributors"
14+
- "open source success stories and tips"
715
---
816

917
It is important to keep track of your open source contributions and show the impact you have left on the projects and organizations. By organizing your work, you will be able to talk about these meaningful contributions on your resume and in job interviews.

docs/job-seekers-guide/introduction.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,14 @@ id: job-seekers-guide-introduction
33
title: "Learn How to Land a Tech Job Using OpenSauced"
44
sidebar_label: "Introduction"
55
keywords:
6-
- job-seekers-guide-introduction
6+
- "job-seekers-guide-introduction"
7+
- "open source tech job guide"
8+
- "open sauced tech job tips"
9+
- "open source career development"
10+
- "open source projects for tech resume"
11+
- "open source skills for tech employers"
12+
- "land your dream tech job"
13+
open sauced:
714
---
815

916
When you are looking for a tech job, it is important to stand out amongst the sea of candidates. One great way to stand out and showcase your skills is through Open Source contributions.

docs/maintainers/maintainers-guide.md

+5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ sidebar_label: "Maintainers Guide to OpenSauced"
55
keywords:
66
- "maintainers"
77
- "guides"
8+
- "open source maintainers guide"
9+
- "open source maintainer"
10+
- "open-source project management"
11+
- "community management in open-source"
12+
- "Maintainers Guide to OpenSauced"
813
---
914

1015
## Introduction to OpenSauced for Maintainers

docs/maintainers/understanding-insights.md

+9
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ sidebar_label: "Understanding Insights Data"
55
keywords:
66
- "maintainers"
77
- "guides"
8+
- "Insights Interpretation"
9+
- "Analytical Understanding"
10+
- "Insights Overview"
11+
- "Maintainer Insights"
12+
- "Guide to Data Understanding"
13+
- "Data Interpretation Methods"
14+
- "Insightful Data Examination"
15+
- "Guide to Understanding Data"
16+
817
---
918

1019
Once your repositories are connected, it's time to understand the data provided in your Insight Page. Understanding this data is key to effectively managing your projects and contributors.

0 commit comments

Comments
 (0)