Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: format and wording adjustments in workspaces, contributors and repo insights sections #262

Merged
merged 56 commits into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from 42 commits
Commits
Show all changes
56 commits
Select commit Hold shift + click to select a range
17d59e4
fix: wording in workspaces.md
adiati98 Feb 27, 2024
d79065b
fix: wording and format in contributors-guide.md
adiati98 Feb 27, 2024
b59ac79
fix: format and wording in repo-insights.md
adiati98 Feb 28, 2024
e54af03
fix: incorrect link and wording in contributor-insights.md
adiati98 Feb 28, 2024
a344a52
fix: add connections to the sidebar
adiati98 Feb 28, 2024
02807ac
fix: format and title capitalization in connections.md
adiati98 Feb 28, 2024
97fdf7f
feat: add info helper in introduction.md
adiati98 Feb 28, 2024
bc1e30f
fix: wording adjustment in categorize-contributions.md
adiati98 Feb 28, 2024
cfccdb4
fix: capitaliazation and add punctuations in job seekers intro
adiati98 Feb 28, 2024
99c811f
fix: change term to PR for consistency in categorize-contributions.md
adiati98 Feb 28, 2024
7fea06f
fix: minor wording adjustment in repo-insights.md
adiati98 Feb 28, 2024
874b32b
fix: link to repo insights for contributor in repo-insights.md
adiati98 Feb 28, 2024
6e8e1a7
fix: revert a link
adiati98 Feb 28, 2024
7ce6801
fix: remove connections from sidebar
adiati98 Feb 28, 2024
24a53fd
fix: typo in connections.md
adiati98 Feb 28, 2024
cb65ae0
Update docs/features/workspaces.md
BekahHW Feb 28, 2024
41f97b9
Update docs/features/workspaces.md
BekahHW Feb 28, 2024
97f793d
fix: change tip to note in workspaces.md
adiati98 Feb 28, 2024
07b56a0
fix: adjust intro paragraph wording in workspaces.md
adiati98 Feb 28, 2024
5925ce0
Merge branch 'fix/workspaces' of https://github.com/open-sauced/docs …
adiati98 Feb 28, 2024
b9807bd
fix: add quote marks in contributors-guide.md
adiati98 Feb 28, 2024
43a8be7
fix: update maintainers-guide.md
adiati98 Feb 28, 2024
2f65cf8
fix: remove incorrect link and adjust wording in contributor-insights.md
adiati98 Feb 29, 2024
8f4473e
Update docs/maintainers/maintainers-guide.md
BekahHW Mar 1, 2024
60142fa
Update docs/contributors/contributors-guide.md
BekahHW Mar 1, 2024
a0fb0b4
fix: punctuations
adiati98 Mar 2, 2024
e0d0c86
fix: remove Reports
adiati98 Mar 2, 2024
0739d45
fix: adjust wording for tabs in contribtors-guide.md
adiati98 Mar 2, 2024
a6e0359
fix: adjust wording for tabs in maintainers-guide.md
adiati98 Mar 2, 2024
31e9224
feat: add Activity subsection to maintainers-guide.md
adiati98 Mar 2, 2024
8c4ef92
fix: add link to activity image and adjust wording
adiati98 Mar 2, 2024
8643223
fix: wording about understandning data
adiati98 Mar 2, 2024
5bd9bf8
fix: adjust wording of a tip in contributors-guide.md
adiati98 Mar 2, 2024
eb15330
feat: add Activity tab subsection in contributors-gude.md
adiati98 Mar 2, 2024
e34c592
fix: remove list of tabs because of duplication
adiati98 Mar 2, 2024
66c6df0
fix: wording in Using Your Repository Insights Page section in contri…
adiati98 Mar 2, 2024
c2e704a
fix: wording in Activity section for contributors and maintainers guide
adiati98 Mar 3, 2024
dc03816
Merge branch 'main' of https://github.com/open-sauced/docs into fix/w…
adiati98 Mar 3, 2024
a72682d
fix: resolve merge conflicts
adiati98 Mar 3, 2024
8bc85eb
fix: wording about data
adiati98 Mar 3, 2024
1c80cf9
fix: capitalization and minor wording in workspaces.md
adiati98 Mar 3, 2024
ff12f01
fix: minor wording in understanding repo and contrib data
adiati98 Mar 3, 2024
817bd8b
Merge branch 'main' of https://github.com/open-sauced/docs into fix/w…
adiati98 Mar 4, 2024
c470748
fix: wording, remove a link and capitalizations in maintainers-guide.md
adiati98 Mar 4, 2024
fec21e9
fix: minor wording in understanding-repo-insights.md
adiati98 Mar 4, 2024
c72c1b2
fix: adjust wording and add alert in contributors-guide.md
adiati98 Mar 4, 2024
9ae9565
fix: capitalizations and adjust wording
adiati98 Mar 4, 2024
773af1d
fix: order in creating a new contrib page section
adiati98 Mar 4, 2024
2590e09
fix: change unordered list to subsections in Using Your Contributor I…
adiati98 Mar 4, 2024
a22d34e
fix: change Contributor to Highlights section in maintainers-guide.md
adiati98 Mar 4, 2024
d4261fd
feat: add note alert for understand more about data provided
adiati98 Mar 4, 2024
c17ab5b
feat: add workspace switcher image
adiati98 Mar 4, 2024
1c60bd1
feat: add workspace switcher link to workspaces.md
adiati98 Mar 4, 2024
49eb4a4
fix: replace section term with feature
adiati98 Mar 4, 2024
2bf1fb8
Update docs/contributors/contributors-guide.md
BekahHW Mar 5, 2024
e338c8f
Update docs/maintainers/maintainers-guide.md
BekahHW Mar 5, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 39 additions & 29 deletions docs/contributors/contributors-guide.md

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/features/connections.md
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?
adiati98 marked this conversation as resolved.
Show resolved Hide resolved

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
adiati98 marked this conversation as resolved.
Show resolved Hide resolved
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.
14 changes: 8 additions & 6 deletions docs/features/repo-insights.md
adiati98 marked this conversation as resolved.
Show resolved Hide resolved
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 @@ -55,5 +59,3 @@ This method gives view-only access to your Repository Insights Page.
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.
4. Share the URL with your team members.


33 changes: 15 additions & 18 deletions docs/features/workspaces.md
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,50 @@ 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
BekahHW marked this conversation as resolved.
Show resolved Hide resolved

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) section was previously called Lists, and the [Repositories Insights](./repo-insights.md) section was previously called Insights.
adiati98 marked this conversation as resolved.
Show resolved Hide resolved

:::


### 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.
adiati98 marked this conversation as resolved.
Show resolved Hide resolved

:::tip
:::note

Whenever you select Home, you'll be taken to the last workspace you opened.
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:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm trying this out again. I think start by creating a workspace name can be confusing and can be a bit misleading here.

So, there are 2 ways to add repositories to a workspace:

  1. Start by clicking the "Add repositories" button. Then, choose an option to add repostories: Search for repositories, Import a GH org, or Import repositories. Afterwards, add the name of the workspace (this is required), and add description (optional).

    add workspace from click add repo

  2. Start by clicking the "Edit" button. Then, add name of the workspace, the repositories, and update/save the workspace.

    add workspace through edit button

We can either include both ways, or include the first one, that make more sense to create a workspce for the first time. But either way, we want to inform that adding the workspace name is required.
We can do it in this PR, or create a new issue for this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there are two issues here: Maybe the issue here is "How to Add repositories to a workspace" and "How to Add Repos to Your Personal Workspace."

We can have two separate lines.

  • Adding repos to a workspace- {description}
  • Adding repos to your personal workspace - {Deseciption}

I believe that only the personal workspace has the edit button. That's because it also takes you to the settings page where you can add workspace members, change the visibility, and upgrade. Which is something I'm going to add to the docs after we get this merged in.

Copy link
Member Author

@adiati98 adiati98 Mar 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, now I see. You're right. Only "Your personal workspace" that has the edit button in the beginning.
Creating new workspace will take us the creation form as below. But once it's created, it also has an edit button.

Screenshot 2024-03-04 204657

I remember that you will add more details to the workspaces, but I'm not sure if this one of them. So, I throw this here, just in case. πŸ˜…

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this could be a separate issue. What do you think @BekahHW?


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
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
Loading