Skip to content

Commit

Permalink
fix: format and wording adjustments in workspaces, contributors and r…
Browse files Browse the repository at this point in the history 
…epo insights sections (open-sauced#262)

* fix: wording in workspaces.md

* fix: wording and format in contributors-guide.md

* fix: format and wording in repo-insights.md

* fix: incorrect link and wording in contributor-insights.md

* fix: add connections to the sidebar

* fix: format and title capitalization in connections.md

* feat: add info helper in introduction.md

* fix: wording adjustment in categorize-contributions.md

* fix: capitaliazation and add punctuations in job seekers intro

* fix: change term to PR for consistency in categorize-contributions.md

* fix: minor wording adjustment in repo-insights.md

* fix: link to repo insights for contributor in repo-insights.md

* fix: revert a link

* fix: remove connections from sidebar

* fix: typo in connections.md

* Update docs/features/workspaces.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/features/workspaces.md

Co-authored-by: Ayu Adiati <[email protected]>

* fix: change tip to note in workspaces.md

* fix: adjust intro paragraph wording in workspaces.md

* fix: add quote marks in contributors-guide.md

* fix: update maintainers-guide.md

* fix: remove incorrect link and adjust wording in contributor-insights.md

* Update docs/maintainers/maintainers-guide.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/contributors/contributors-guide.md

Co-authored-by: Ayu Adiati <[email protected]>

* fix: punctuations

* fix: remove Reports

* fix: adjust wording for tabs in contribtors-guide.md

* fix: adjust wording for tabs in maintainers-guide.md

* feat: add Activity subsection to maintainers-guide.md

* fix: add link to activity image and adjust wording

* fix: wording about understandning data

* fix: adjust wording of a tip in contributors-guide.md

* feat: add Activity tab subsection in contributors-gude.md

* fix: remove list of tabs because of duplication

* fix: wording in Using Your Repository Insights Page section in contributors-guide.md

* fix: wording in Activity section for contributors and maintainers guide

* fix: wording about data

* fix: capitalization and minor wording in workspaces.md

* fix: minor wording in understanding repo and contrib data

* fix: wording, remove a link and capitalizations in maintainers-guide.md

* fix: minor wording in understanding-repo-insights.md

* fix: adjust wording and add alert in contributors-guide.md

* fix: capitalizations and adjust wording

* fix: order in creating a new contrib page section

* fix: change unordered list to subsections in Using Your Contributor Insights Page of contributors-guide.md

* fix: change Contributor to Highlights section in maintainers-guide.md

* feat: add note alert for understand more about data provided

* feat: add workspace switcher image

* feat: add workspace switcher link to workspaces.md

* fix: replace section term with feature

* Update docs/contributors/contributors-guide.md

Co-authored-by: Ayu Adiati <[email protected]>

* Update docs/maintainers/maintainers-guide.md

Co-authored-by: Ayu Adiati <[email protected]>

---------

Co-authored-by: BekahHW <[email protected]>
  • Loading branch information
@adiati98 @BekahHW
adiati98 and BekahHW authored Mar 5, 2024
1 parent fe55e8f commit 37bddac
Show file tree
Hide file tree
Showing 15 changed files with 226 additions and 168 deletions.
112 changes: 73 additions & 39 deletions docs/contributors/contributors-guide.md
View file

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/features/connections.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,20 @@ keywords:
- "Online connections"
- "Networking opportunities"
- "tech connections"
- "grow newtwork"
- "grow network"
- "grow connection"
- "Community 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 [Contributor Insights](contributor-insights.md) 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 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 [Contributor Insights](contributor-insights.md) 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?
## 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.
Expand Down
13 changes: 6 additions & 7 deletions docs/features/contributor-insights.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,20 @@ keywords:

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

Monitor individual commit histories, track who is actively engaged, identify alumni 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.
Monitor individual commit histories, track who is actively engaged, identify alumni 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.

![Contributor Insights -page](../../static/img/lists-page.svg)
![Contributor Insights Page](../../static/img/lists-page.svg)

## How to Create a Contributor Insight Page

After logging in, navigate to your [Contributor Insights Page](https://app.opensauced.pizza/hub/lists/).
After logging in, navigate to "Insights" in the sidebar. Click the "+" next to it to be presented with options, and select "New Contributor Insight."

There are three ways to add a list:

1. **Explore Contributors**: Use our explore tool to find contributors and create your list.
2. **Sync your GitHub Team**: Connect to your GitHub to create a Contributor Insight Page from a team in your organization.
3. **Import your GitHub Following**:
Connect to your GitHub to create a Contributor Insight Page with all the contributors you follow.
3. **Import your GitHub Following**: Connect to your GitHub to create a Contributor Insight Page with all the contributors you follow.

Once your Contributor Insight Pageis 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.
Once your Contributor Insight Page 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.

If you're having trouble syncing your Organization or Team, check out our [Sync Your GitHub Team in our FAQs](../welcome/faqs.md#sync-your-github-team).
If you're having trouble syncing your Organization or Team, check out the "[Sync Your GitHub Team](../welcome/faqs.md#sync-your-github-team)" section in our FAQs.
18 changes: 10 additions & 8 deletions docs/features/repo-insights.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ keywords:
- "Repository Insights"
- "open source"
- "projects"
- "Open Source Repository Insights"
- "Open Source Repository Insights"
- "Project Repository Insights"
- "Repository Insights into Open Source Projects"
- "Open Source Project Repository Insights"
---

The Repository 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 Repository 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.
The Repository 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 Repository 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)

Expand All @@ -28,7 +28,9 @@ The Repository Insights feature is your one-stop solution for understanding the
- To aid in the job search process.

:::tip
To learn more about how to use Repository Insights as a contributor, check out our [Contributors Guide to OpenSauced](../contributors/contributors-guide.md).

Check out our [Contributors Guide to OpenSauced](../contributors/contributors-guide.md#repository-insights-connecting-your-repositories) to learn more about how to create and use Repository Insights as a contributor.

:::

### Maintainers
Expand All @@ -38,7 +40,9 @@ To learn more about how to use Repository Insights as a contributor, check out o
- To find new contributors to support your project.

:::tip
To learn more about how to use Repository Insights, check out our [Maintainers Guide](../maintainers/maintainers-guide.md) and our [Understanding Repository Insights Data](../maintainers/understanding-repo-insights.md) pages.

Check out our [Maintainers Guide to OpenSauced](../maintainers/maintainers-guide.md) and our [Understanding Repository Insights Data](../maintainers/understanding-repo-insights.md) pages to learn more about how to create and use Repository Insights as a maintainer.

:::

## Sharing Your Repository Insights Page with Your Team
Expand All @@ -52,8 +56,6 @@ Sharing this page with your team ensures that everyone is well-informed about th
This method gives view-only access to your Repository Insights Page.

1. Navigate to your sidebar.
2. Click the Repository Insight page that you want to share.
3. On the top right, click the "Share" button to copy the Repository Insights Page URL to the clipboard.
2. Click the Repository Insight Page that you want to share.
3. On the top right, click the "Share" button to copy the Repository Insight Page URL to the clipboard.
4. Share the URL with your team members.


37 changes: 19 additions & 18 deletions docs/features/workspaces.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ keywords:
- "open source contributors"
---

In the OpenSauced app, your work unfolds within a Workspace, a virtual environment designed to organize information for yourself, collaborating as a team, or operating across an entire company. Workspaces are a place to share, collaborate, and track open source projects and contributors.
In the OpenSauced app, your work unfolds within a Workspace: a virtual environment for managing information—whether for individual productivity, team collaboration, or company-wide operations. Workspaces serve as a centralized hub for sharing, collaborating on, and monitoring open source projects and their contributors. This feature is designed to streamline your open source involvement, making it more efficient and interconnected.

## Understanding Workspaces

Expand All @@ -25,53 +25,54 @@ By default, all workspaces are public. This means that anyone with the link to y

The expandable sidebar includes:

- Options for creating and viewing workspaces.
- Access to your Contributor and Repository Insights pages.
- Links to support.
- Options for creating and viewing workspaces.
- Access to your Contributor and Repository Insights pages.
- Links to support.

![Sidebar](../../static/img/workspace-sidebar.png)
![Sidebar](../../static/img/workspace-sidebar.png)

:::tip
:::info

We recently had a naming change. The Contributors Insights section was previously called [Lists](contributor-insights.md), and the Repositories Insights section was previously called [Insights](./repo-insights.md).
We recently had a naming change. The [Contributors Insights](contributor-insights.md) feature was previously called Lists, and the [Repositories Insights](./repo-insights.md) feature was previously called Insights.

:::


### Your Workspaces

In your workspace dashboards, you can create, view, and manage your workspaces.
In your workspace dashboards, you can create, view, and manage your workspaces.

#### Repositories Dashboard

![Workspaces](../../static/img/workspace.png)

Within the repositories dashboard, you can view the following metrics, which are over a period of thirty days by default:

- **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 requestions being merged.
- **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.
- **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.
- **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.
- **Engagement**: This includes the total stars, forks, and activity ratio for the repositories included in your workspace.


## How to Create or Access a Workspace

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.

:::tip
![workspace switcher](../../static/img/workspace-switcher.png)

<br/>

Whenever you select Home, you'll be taken to the last workspace you opened.
:::note

Whenever you select "Home", you'll be taken to the last workspace you opened.

:::

### How to Add Repositories to a Workspace

If you're creating a new workspace, you'll have the option to add repositories at the time of creation.

Start by creating a Workspace name, and then click `Add repositories`. You'll have three options for adding repositories:
Start by creating a workspace name, then click "Add repositories." You'll have three options for adding repositories:

1. **Search for Repositories**: Use our search tool by adding an organization name, followed by the repository name and add them to your workspace.
1. **Search for Repositories**: Use our search tool by adding an organization name, followed by the repository name, and add them to your workspace.
2. **Import a GitHub Organization**: Connect to your GitHub organizations to create a workspace from an organization.
3. **Import Repositories**: Paste a list of repositories to add to your workspace.

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 at any time.

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.
6 changes: 5 additions & 1 deletion docs/introduction.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ keywords:

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

[Watch this on YouTube](https://www.youtube.com/watch?v=h8gwrzis-dY&list=PLHyZ0Wz_A44XAE-6Gbd69pZLTdqWdwlBx&index=1&t=2s).
:::info

You can watch "[What is OpenSauced?](https://www.youtube.com/watch?v=h8gwrzis-dY&list=PLHyZ0Wz_A44XAE-6Gbd69pZLTdqWdwlBx&index=1&t=2s)" on YouTube.

:::

OpenSauced is a platform dedicated to empowering maintainers and teams and redefining the meaning of open source contributions. We believe that every contribution, big or small, is valuable and deserves to be recognized. Our platform provides a way to track contributions through a GitHub-powered dashboard, allowing users to showcase their contributions and gain insights into their open source projects.

Expand Down
Loading

0 comments on commit 37bddac

Please sign in to comment.