Skip to content

Commit 36488c5

Browse files
authored
Merge branch 'open-sauced:main' into main
2 parents 5c53a04 + 6660e54 commit 36488c5

File tree

10 files changed

+451
-27
lines changed

10 files changed

+451
-27
lines changed
+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Adds all issues opened in the /docs repo to the Team Dashboard
2+
3+
on:
4+
issues:
5+
types:
6+
- opened
7+
8+
jobs:
9+
add-to-project:
10+
name: Add issue to project
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Generate token
14+
id: generate_token
15+
uses: tibdex/github-app-token@v1
16+
with:
17+
app_id: ${{ secrets.OS_GITHUB_APP_ID }}
18+
private_key: ${{ secrets.OS_GITHUB_APP_PRIVATE_KEY }}
19+
20+
- name: add issue to team dashboard
21+
uses: actions/[email protected]
22+
with:
23+
project-url: https://github.com/orgs/open-sauced/projects/25
24+
github-token: ${{ steps.generate_token.outputs.token }}

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.69.0](https://github.com/open-sauced/docs/compare/v1.68.0...v1.69.0) (2024-03-21)
9+
10+
11+
### Features
12+
13+
* Add student guide ([#283](https://github.com/open-sauced/docs/issues/283)) ([eb591fd](https://github.com/open-sauced/docs/commit/eb591fdf7aec5b31d3c1f18b88060c759a0f4815))
14+
15+
## [1.68.0](https://github.com/open-sauced/docs/compare/v1.67.1...v1.68.0) (2024-03-20)
16+
17+
18+
### Documentation
19+
20+
* Add section on workspaces to maintainers guide ([#279](https://github.com/open-sauced/docs/issues/279)) ([c0fe6b9](https://github.com/open-sauced/docs/commit/c0fe6b96869d88dff8205c05f32f754679ebc457))
21+
822
### [1.67.1](https://github.com/open-sauced/docs/compare/v1.67.0...v1.67.1) (2024-03-12)
923

1024

docs/contributors/contributors-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Sharing the story of your hard work is an opportunity to connect with the reader
103103

104104
1. **Describe the topic**: Begin with an interesting blog post summary to help your peers and potential recruiters understand your writing.
105105
2. **Discuss the inspiration**: Explain why you wrote this blog post. Is it to guide others on improving their coding skills, raise awareness about an issue in the tech community, or display your progress in learning a new programming language?
106-
3. **End with a call-to-action**: Encourage readers to read and engage with the post, whether by commenting or sharing it with others on social media.
106+
3. **End with a call-to-action**: Encourage readers to read and engage with the post.
107107

108108
## Repository Insights: Connecting Your Repositories
109109

docs/maintainers/maintainers-guide.md

+57-2
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,66 @@ keywords:
1212

1313
## Introduction to OpenSauced for Maintainers
1414

15-
OpenSauced is a platform dedicated to empowering maintainers and redefining open source contributions. We offer a GitHub-powered dashboard for tracking contributions and gaining insights into your open source projects. You can customize your [Repository Insights](#repository-insights-connecting-your-repositories) and [Contributor Insights](#contributor-insights-connecting-with-contributors) with the repositories you choose and the contributors you want to see.
15+
OpenSauced is a platform dedicated to empowering maintainers and redefining open source contributions. We offer a GitHub-powered dashboard for tracking contributions and gaining insights into your open source projects. You can create a [Workspace](#your-workspace-streamlining-open-source-project-management) to collaborate with your team and customize your [Repository Insights](#repository-insights-connecting-your-repositories) and [Contributor Insights](#contributor-insights-connecting-with-contributors) with the repositories you choose and the contributors you want to see.
1616

1717
## Getting Started
1818

19-
To get started, you will need to create an account on OpenSauced. You can do this by visiting the [app.opensauced.pizza](https://app.opensauced.pizza) and clicking the "Connect with GitHub" button. You will be prompted to sign in with your GitHub account. Once you have signed in, you will be redirected to the OpenSauced dashboard.
19+
To get started, you will need to create an account on OpenSauced. You can do this by visiting the [app.opensauced.pizza](https://app.opensauced.pizza) and clicking the "Connect with GitHub" button. You will be prompted to sign in with your GitHub account. Once you have signed in, you will be redirected to your Workspace.
20+
21+
## Your Workspace: Streamlining Open Source Project Management
22+
23+
When you're working with a team, managing multiple projects or even an assortment of repositories within a single project can become overwhelming, especially as you try to keep everyone up-to-date on key information that impacts your projects. Understanding the direction and value of your project can be challenging. To navigate these challenges effectively, you can use Workspaces to:
24+
25+
- **Understand your project at a high level**: Being able to look at all your repositories and understand them at a high level makes it easier for you to share this information, collaborate with others, and understand where your projects stand in terms of health.
26+
- **Collaborate and create transparency with your team**: Understanding the activity for all of your projects equips you to make decisions as a team, set goals for your projects, and understand what brings the most value to those using your project.
27+
- **Streamline contributor engagement**: Having a high level understanding of your project is a good step in understanding your project’s value, but really understanding what’s happening beneath the surface is the next step in being able to assess project health, growth, and the contributor community.
28+
- **Measure and share success**: Without insight into your project's activity level, health, and contributor community, it can be a challenge to show the value of your projects. Having real-time analytics on your projects can help you to highlight your key achievements, recognize the impact of your contributors, and communicate the hard work that’s been put into your projects.
29+
30+
Workspaces is a feature designed to provide maintainers and teams with a centralized platform for organizing, tracking, and analyzing their open source activity. Workspaces gives you a holistic view of project health, team collaboration, and contributor engagement.
31+
32+
### Creating a New Workspace
33+
34+
To create a workspace, start by accessing the **Workspace switcher** in the sidebar. From there, you can create a new workspace or view an existing one.
35+
36+
![workspace switcher](../../static/img/workspace-switcher.png)
37+
38+
<br/>
39+
40+
:::note
41+
42+
Whenever you select "Home", you'll be taken to the last workspace you opened.
43+
44+
:::
45+
46+
### Adding Repositories to Your Workspace
47+
48+
If you're creating a new workspace, you'll have the option to add repositories at the time of creation.
49+
50+
Start by creating a workspace name, then click "Add repositories." You'll have three options for adding repositories:
51+
52+
1. **Search for Repositories**: Use our search tool by adding an organization name, followed by the repository name, and add them to your workspace.
53+
2. **Import a GitHub Organization**: Connect to your GitHub organizations to create a workspace from an organization. (If you're having trouble with this, see the "[Sync Your GitHub Team](../welcome/faqs.md#sync-your-github-team)" section in our FAQs.)
54+
3. **Import Repositories**: Paste a list of repositories to add to your workspace.
55+
56+
Once your repositories are added, you'll be able to see them in your repository dashboard. You can also edit your workspace to add or remove repositories anytime.
57+
58+
### Navigating Your Workspace
59+
60+
Once your repositories are connected, you'll enter your Workspace dashboard. In your workspace dashboards, you can create, view, and manage your workspaces.
61+
62+
#### Repositories Dashboard
63+
64+
![Workspaces](../../static/img/workspace.png)
65+
66+
Within the repositories dashboard, you can view the following metrics, which are over a period of thirty days by default:
67+
68+
- **Pull Requests**: This includes the total opened and merged pull requests for the repositories included in your workspace, as well as the velocity of pull requests being merged.
69+
- **Issues**: This includes the total opened and closed issues for the repositories included in your workspace, as well as the velocity of issues being closed.
70+
- **Engagement**: This includes the total stars, forks, and activity ratio for the repositories included in your workspace.
71+
72+
Using Workspaces is a new way of approaching open source project management. By centralizing the oversight of your projects and facilitating team collaboration, Workspaces help you to make informed decisions, prioritize effectively, and foster a thriving open source community.
73+
74+
Beyond workspaces, you may want to get insights into other repositories and contributors to help you understand the health and growth of your projects. One way to do that is through Repository Insights.
2075

2176
## Repository Insights: Connecting Your Repositories
2277

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

+10-10
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ As you fill out the remaining sections for project contributions, check to see i
5757

5858
After you have filled out the career section of the table, you will want to find open source projects that align with your goals. You can use the explore feature on OpenSauced to explore new repositories in a variety of topics like [JavaScript](https://app.opensauced.pizza/javascript/dashboard/filter/recent?range=30), [Python](https://app.opensauced.pizza/python/dashboard/filter/recent?range=30), and [Machine Learning](https://app.opensauced.pizza/ml/dashboard/filter/recent?range=30).
5959

60-
![Explore Machine Learning projects in OpenSauced](../../static/img/ml-explore-page.png)
60+
![Explore Machine Learning projects in OpenSauced](../../../static/img/ml-explore-page.png)
6161

6262
Finding a good project to contribute to takes time. So, make sure to look at the frequency of contributions to the project and the types of issues and features the project needs help with. If it aligns with your career goals, then start off with smaller issues before moving to larger features. You will also want to join the project's community chat room or Discord channel to connect with other contributors and core team members of the project.
6363

@@ -104,27 +104,27 @@ For each project contribution, you will want to list the date, a brief summary o
104104

105105
### Using the Highlights Feature to Track Your Contributions
106106

107-
The [Highlights feature](../features/highlights.md) is where you can display your favorite open source contributions and share your open source story.
107+
The [Highlights feature](../../features/highlights.md) is where you can display your favorite open source contributions and share your open source story.
108108

109-
![OpenSauced Highlights](../../static/gif/highlight.gif)
109+
![OpenSauced Highlights](../../../static/gif/highlight.gif)
110110

111111
You can use this feature to help you track the open source contributions you are most proud of and share your accomplishments with your network. All your highlights will appear on your OpenSauced profile. So, sharing your profile is another way to let potential employers see the types of contributions you've made and the highlights you've identified as the most important.
112112

113113
### Using the Contributor Insight Feature to Follow People
114114

115-
The [Contributor Insights feature](../features/contributor-insights.md) enables you to categorize, monitor, and analyze different groups of contributors within open source projects.
115+
The [Contributor Insights feature](../../features/contributor-insights.md) enables you to categorize, monitor, and analyze different groups of contributors within open source projects.
116116

117117
You can use this feature to create a list of people you interacted with during your open source work. If you continually work with the same individuals, they can act as referrals and references for jobs.
118118

119119
Contributor Insights can also be used to track other people in your network to reach out to about their contributions.
120120

121-
![Contributor Insights page](../../static/img/lists-page.svg)
121+
![Contributor Insights page](../../../static/img/lists-page.svg)
122122

123123
### Using the Repository Insights Feature to Track the Repositories You Contributed to
124124

125-
The [Repository Insights feature](../features/repo-insights.md) is a comprehensive view of a project's health and individual contributions. You can use it to track the repositories you contributed to or to track repositories of open source companies that are hiring.
125+
The [Repository Insights feature](../../features/repo-insights.md) is a comprehensive view of a project's health and individual contributions. You can use it to track the repositories you contributed to or to track repositories of open source companies that are hiring.
126126

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

129129
### Networking and Professional Development
130130

@@ -141,11 +141,11 @@ If you have corresponded with the same core contributors and maintainers over th
141141

142142
### Using Your OpenSauced Dev Card for Networking
143143

144-
Your [OpenSauced Dev Card](../features/dev-card.md) serves as your "open source business card" to showcase all of your recent open source activities. You will find recent activity concerning the projects you contribute to, the frequency of PRs, and projects you are interested in.
144+
Your [OpenSauced Dev Card](../../features/dev-card.md) serves as your "open source business card" to showcase all of your recent open source activities. You will find recent activity concerning the projects you contribute to, the frequency of PRs, and projects you are interested in.
145145

146146
You can easily share your Dev Card on social media platforms like X/Twitter and LinkedIn to gain attention from potential recruiters and hiring managers.
147147

148-
![OpenSauced Dev card](../../static/img/a-dev-card.png)
148+
![OpenSauced Dev card](../../../static/img/a-dev-card.png)
149149

150150
### Reflection and Next Steps
151151

@@ -166,7 +166,7 @@ After each contribution, you will want to update your LinkedIn profile and resum
166166

167167
The Highlights feature allows you to post about your recent open source contributions on OpenSauced and share them with other social media outlets like Twitter and LinkedIn.
168168

169-
![OpenSauced Highlights Feature](../../static/img/highlights.png)
169+
![OpenSauced Highlights Feature](../../../static/img/highlights.png)
170170

171171
| **Section** | **Details** |
172172
| ------------------------------------------ | ------------------------------------------ |

docs/job-seekers-guide/introduction.md docs/opensauced-guides/job-seekers-guide/introduction.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ keywords:
99
- "open source projects for tech resume"
1010
- "open source skills for tech employers"
1111
- "land your dream tech job"
12-
open sauced:
1312
---
1413

1514
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.
@@ -18,4 +17,4 @@ Open source provides you the opportunity to showcase your code, documentation, c
1817

1918
OpenSauced can help you craft an open source profile that is attractive to hiring managers and recruiters and help you land that next role.
2019

21-
In this guide, you will learn how to use OpenSauced features like your personal [Dev Card](../features/dev-card.md), [Highlights](../features/highlights.md), [Contributor Insights](../features/contributor-insights.md), and [Repository Insights](../features/repo-insights.md) to showcase your open source work and build connections to help you land a job.
20+
In this guide, you will learn how to use OpenSauced features like your personal [Dev Card](../../features/dev-card.md), [Highlights](../../features/highlights.md), [Contributor Insights](../../features/contributor-insights.md), and [Repository Insights](../../features/repo-insights.md) to showcase your open source work and build connections to help you land a job.

0 commit comments

Comments
 (0)