diff --git a/docs/contributors/contributors-guide.md b/docs/contributors/contributors-guide.md index ea6e2cc2..d6fea72d 100644 --- a/docs/contributors/contributors-guide.md +++ b/docs/contributors/contributors-guide.md @@ -47,7 +47,7 @@ The "Explore" tab is a great place to start if you're looking for a new open sou Once you've selected your filters, you'll be able to see the contributors, spam, and activity levels of the repository. Understanding the activity level and PR velocity of a repository can help you determine if it's a good fit for you to contribute to and what to expect when you submit a PR. -For example, if you wanted to look for a JavaScript project to contribute to, you would select "JavaScript" from the language dropdown and "Most Active" from the filter dropdown to see the most active JavaScript projects on GitHub. If you want to keep track of the repositories you're interested in contributing to, you can add them to your [Insights page](../features/insights.md). +For example, if you wanted to look for a JavaScript project to contribute to, you would select "JavaScript" from the language dropdown and "Most Active" from the filter dropdown to see the most active JavaScript projects on GitHub. If you want to keep track of the repositories you're interested in contributing to, you can add them to your [Repository Insights page](../features/repo-insights.md). ## Highlights: Connecting and Recognizing Contributions @@ -96,34 +96,34 @@ Sharing the story of your hard work is an opportunity to connect with the reader 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? 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. -## Insights: Connecting Your Repositories +## Repository Insights: Connecting Your Repositories -OpenSauced [Insights](../features/insights.md) allows you to track open source projects you are interested in. You can use Insights Pages to track repositories' growth, analyze work, and connect with others. +OpenSauced [Repository Insights](../features/repo-insights.md) allows you to track open source projects you are interested in. You can use Repository Insights Pages to track repositories' growth, analyze work, and connect with others. -### Why Create an Insights Page +### Why Create an Repository Insights Page - **To track projects you're working on**: Tracking projects you're working on can help you stay up-to-date with the latest activity, trends, and connect with other contributors. -- **To identify potential projects to contribute to**: If you're looking for a new project to contribute to, you can use the Insights feature to track active projects that are looking for contributors. You can use the Explore tool to find new projects to contribute to and track them with your Insights page. +- **To identify potential projects to contribute to**: If you're looking for a new project to contribute to, you can use the Repository Insights feature to track active projects that are looking for contributors. You can use the Explore tool to find new projects to contribute to and track them with your Repository Insights page. - **To network and engage with the community**: Finding people to work and connect with can be challenging. Through the feature's "Contributors" tab, you can connect with your network. -- **To track the activity of a topic you're interested in**: Keeping up with the latest trends and activity in a specific topic can be challenging. You can use the Insights feature to track the activity of a specific topic and find new projects to contribute to. For example, you can create an [Insight page for Active AI Repositories](https://app.opensauced.pizza/pages/BekahHW/1055/dashboard). -- **To track the activity of your favorite programming languages**: If you're interested in tracking the activity of your favorite programming languages, you can use the Insights feature to track the open source projects that are using them. -- **To aid in the job search**: If you're looking for a job, you can use the Insights feature to track the activity of the organizations you're interested in working on. This can help you understand the activity level of the repositories and the types of contributions that are being made, and even identify which company you want to contribute to. +- **To track the activity of a topic you're interested in**: Keeping up with the latest trends and activity in a specific topic can be challenging. You can use the Repository Insights feature to track the activity of a specific topic and find new projects to contribute to. For example, you can create an [Insight page for Active AI Repositories](https://app.opensauced.pizza/pages/BekahHW/1055/dashboard). +- **To track the activity of your favorite programming languages**: If you're interested in tracking the activity of your favorite programming languages, you can use the Repository Insights feature to track the open source projects that are using them. +- **To aid in the job search**: If you're looking for a job, you can use the Repository Insights feature to track the activity of the organizations you're interested in working on. This can help you understand the activity level of the repositories and the types of contributions that are being made, and even identify which company you want to contribute to. - **Curating collections for interest groups**: You can curate and share repositories focusing on sectors and programming languages that interest you. -### Creating a New Insight Page +### Creating a New Repository Insight Page -To track the repositories, click the "Insights" tab on the top left bar. You will be redirected to a page where you can create your new Insight Page. +To track the repositories, click the "+" next to Insights in the sidebar, then select New Repository Insight. You will be redirected to a page where you can create your new Repository Insight Page. -There are two ways to add repositories to your Insight Page: +There are two ways to add repositories to your Repository Insight Page: 1. **Sync GitHub organization**: Syncing your GitHub organizations is a good idea if you want to keep track of their open source project activities and trends. 2. **Connect individual repositories**: Connecting individual repositories is a good idea if you want to keep track of the contributions of a specific repository or group of repositories. -![sync insights gif](../../static/gif/insight-page-demo.gif) +![sync Repository Insights gif](../../static/gif/insight-page-demo.gif) -### Using Your Insights Page +### Using Your Repository Insights Page -Once you have connected your repositories, you will be redirected to your Insight Page. Here, you will see a dashboard with an overview of the repositories and the contributors who have contributed to them. +Once you have connected your repositories, you will be redirected to your Repository Insight Page. Here, you will see a dashboard with an overview of the repositories and the contributors who have contributed to them. There are four tabs that provide you with more information on these repositories: @@ -148,13 +148,13 @@ The "Contributors" tab allows you to view more detailed information about other Want to learn more about your peers? You can select them and add them to a list. ::: -To learn more about these features, see [Understanding Insights Data](../maintainers/understanding-insights.md). +To learn more about these features, see [Understanding Repository Insights Data](../maintainers/understanding-repo-insights.md). -## Lists: Connecting with Contributors +## Contributor Insights: Connecting with Contributors -The [Lists](../features/lists.md) feature helps you connect with other contributors or learn more about what others are up to in open source. With this feature, you can categorize, watch, and check out different groups of contributors within open source projects. +The [Contributor Insights](../features/contributor-insights.md) feature helps you connect with other contributors or learn more about what others are up to in open source. With this feature, you can categorize, watch, and check out different groups of contributors within open source projects. -### What You Can Do With Lists? +### What You Can Do With Contributor Insights? There are many things you can do with this feature, but here are some ideas to get you started: @@ -163,19 +163,19 @@ There are many things you can do with this feature, but here are some ideas to g - **See who's using OpenSauced Highlights feature**: You can see who's using the Highlights feature and show them support by giving an emoji reaction. - **Track contributors for job opportunities**: If you're looking for a job, you can track the activity of the contributors you're interested in working with. This helps you understand the activity level of the repositories and the types of contributions being made, and you can even identify which company you want to contribute to. -### Creating a New List +### Creating a New Contributor Insights Page -1. Click the "Lists" tab on the Insights hub to create a new list. You will be redirected to a page where you can create your new list. -2. Click on the "New List" button to start a new list. +1. Click the "+" next to Insights in your side bar. "Contributor Insights" tab on the Repository Insights hub to create a new list. You will be redirected to a page where you can create your new list. +2. Select New Contributor Insight to start a new Contributor Insight Page. 3. Give your list a name. -4. Choose your page visibility. You can choose to make your list public or private. By default, it is set to private. +4. Choose your page visibility. You can choose to make your list public or private. By default, it is set to public. To create a private page, you can upgrade your account to a paid plan. 5. Add contributors to your list by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following. ![contribution sync gif](../../static/gif/contributors-sync-list.gif) -## Using Your List +## Using Your Contributor Insights Page -Once you have created your list, you will be redirected to your List Page. Here, you will see a dashboard with an overview of the contributors. +Once you have created your list, you will be redirected to your Contributor Insights Page. Here, you will see a dashboard with an overview of the contributors. There are three tabs that provide you with more information on these repositories: @@ -183,15 +183,15 @@ There are three tabs that provide you with more information on these repositorie - **Activity**: The "Activity" tab gives you a graph view with more detailed information on each contributor, including the type of activity, repositories they've contributed to, and how they compare to each other. - **Highlights**: The "Highlights" tab gives you a list of the highlights that the contributors in your list have created. This is a great way to see what other contributors are up to and to show them support. -To learn more about these features, see [Understanding Lists Data](../maintainers/understanding-lists-data.md). +To learn more about these features, see [Understanding Contributor Insights Data](../maintainers/understanding-contrib-insights.md). ## Takeaways - **Create Your Profile**: Creating your profile is a great way to display your open source contributions, connect with other contributors and maintainers, and share during a job search. - **Explore**: The "Explore" tab is a great place to find new open source projects to contribute to. - **Highlights**: Leveraging OpenSauced's Highlights feature is a great way for you to showcase your valuable contributions to open source projects. -- **Insights**: OpenSauced Insights allows you to track open source projects you are interested in. -- **Lists**: The Lists feature helps you understand other contributors or track your own work in open source. +- **Repository Insights**: OpenSauced Repository Insights allows you to track open source projects you are interested in. +- **Contributor Insights**: The Contributor Insights feature helps you understand other contributors or track your own work in open source. ## Conclusion diff --git a/docs/features/connections.md b/docs/features/connections.md index 38ff2e4e..1dbbbcba 100644 --- a/docs/features/connections.md +++ b/docs/features/connections.md @@ -18,7 +18,7 @@ keywords: ## 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 [Lists](lists.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) diff --git a/docs/features/contributor-insights.md b/docs/features/contributor-insights.md new file mode 100644 index 00000000..8358a942 --- /dev/null +++ b/docs/features/contributor-insights.md @@ -0,0 +1,33 @@ +--- +id: contributor-insights +title: "Organize and Monitor Your Contributors" +sidebar_label: "Contributor Insights" +keywords: + - "contributor insights" + - "contributors" + - "organize" + - "Monitor Contributors" + - "Organize Contributors" + - "Contributor Contributor Insights Management" +--- + +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. + +![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/). + +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. + +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. + +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). diff --git a/docs/features/highlights.md b/docs/features/highlights.md index 7d626613..410cb87a 100644 --- a/docs/features/highlights.md +++ b/docs/features/highlights.md @@ -20,13 +20,13 @@ There are currently three types of highlights you can add to your profile: ## How to Add a Highlight -- Go to [OpenSauced's Highlights feed](https://insights.opensauced.pizza/feed). +- Go to [OpenSauced's Highlights feed](https://app.opensauced.pizza/feed). - Click 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 Highlights feed](https://insights.opensauced.pizza/feed). +For more examples of highlights, go to the [OpenSauced Highlights feed](https://app.opensauced.pizza/feed). Eager to get started? Check out the [Effectively Highlight Your Contribution](https://intro.opensauced.pizza/#/06-the-secret-sauce?id=effectively-highlight-your-contributions) section in our free "Intro to Open Source" course to learn more. diff --git a/docs/features/insights.md b/docs/features/insights.md deleted file mode 100644 index 74e8e4c0..00000000 --- a/docs/features/insights.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -id: insights -title: "Insights into Open Source Projects" -sidebar_label: "Insights" -keywords: - - "insights" - - "open source" - - "projects" - - "Open Source Insights" - - "Project Insights" - - "Insights into Open Source Projects" - - "Open Source Project 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. - -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. - -## Sharing Your Insights Page with Your Team - -After you've created your Insights Page, share it with your team. - -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. - -### How to Share Insights Page - -There are two methods to share your Insights Page: - -#### Method 1: Using the Share Button - -This method gives view-only access to your Insights Page. - -1. Click the "Insights" tab at the top bar. -2. Click the page that you want to share. -3. On the top right, click the "Share" button to copy the Insights Page URL to the clipboard. -4. Share the URL with your team members. - -#### Method 2: Adding a Team Member - -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. - -1. Click the "Insights" tab at the top bar. -2. Click the page that you want to share. -3. Click the "Edit Page" button on the top right. -4. Scroll down to the "Add Team Members" section. -5. Enter the email address of the team member you want to invite. -6. Click the "Send invite" button.
Once you click the button, your team member's email will be listed at the bottom. -7. To select and give permission to your team member, click the arrow button on the right side of their email. - -To learn more about inviting your team, check out [this tutorial video](https://www.youtube.com/watch?v=L5ztLP1O7BY). diff --git a/docs/features/lists.md b/docs/features/lists.md deleted file mode 100644 index 5ed0df25..00000000 --- a/docs/features/lists.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -id: lists -title: "Organize and Monitor Your Contributors" -sidebar_label: "Lists" -keywords: - - "lists" - - "contributors" - - "organize" - - "Monitor Contributors" - - "Organize Contributors" - - "Contributor Lists Management" ---- - -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. - -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. - -![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 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 list from a team in your organization. -3. **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. - -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). diff --git a/docs/features/repo-insights.md b/docs/features/repo-insights.md new file mode 100644 index 00000000..0b664b07 --- /dev/null +++ b/docs/features/repo-insights.md @@ -0,0 +1,59 @@ +--- +id: repo-insights +title: "Insights into Open Source Repositories" +sidebar_label: "Repository Insights" +keywords: + - "Repository Insights" + - "open source" + - "projects" + - "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. + +![insight-pages-demo](../../static/gif/insight-page-demo.gif) + +## How to Use Repository Insights + +### Contributors + +- To track projects you're working on. +- To identify potential projects to contribute to. +- To discover other contributors to collaborate with. +- To track the activity of a topic you're interested in. +- To track the activity of your favorite programming languages. +- 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). +::: + +### Maintainers + +- To track the health of your project. +- To identify contributors who are making an impact. +- 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. +::: + +## Sharing Your Repository Insights Page with Your Team + +After you've created your Repository Insights Page, share it with your team. + +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. + +### How to Share Repository Insights Page + +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. +4. Share the URL with your team members. + + diff --git a/docs/features/workspaces.md b/docs/features/workspaces.md new file mode 100644 index 00000000..8bc429cf --- /dev/null +++ b/docs/features/workspaces.md @@ -0,0 +1,77 @@ +--- +id: workspaces +title: "Share, Collaborate, and Track with Workspaces" +sidebar_label: "Workspaces" +keywords: + - "contributors" + - "Monitor Contributors" + - "Track open source projects" + - "open source teams" + - "open source companies" + - "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. + +## Understanding Workspaces + +You can navigate your workspaces from the sidebar. Each workspace has its own dashboard, which includes the repositories you're tracking in the workspace. + +![Workspace Access](../../static/img/access-workspace.png) + +By default, all workspaces are public. This means that anyone with the link to your workspace can view it. If you want to make your workspace private, you can upgrade your account to a paid plan. + +### The Sidebar + +The expandable sidebar includes: + + - Options for creating and viewing workspaces. + - Access to your Contributor and Repository Insights pages. + - Links to support. + + ![Sidebar](../../static/img/workspace-sidebar.png) + +:::tip + + 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). + +::: + + +### 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. +- **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 + +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: + +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. + diff --git a/docs/introduction.md b/docs/introduction.md index a88cbcff..a53dd4b6 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -17,7 +17,7 @@ OpenSauced is a platform dedicated to empowering maintainers and teams and redef Our mission is to: -- **Empower maintainers and teams**: Track and showcase your contributions and projects, connect with contributors, collaborate with your team, and gain insights into your open source projects. -- **Support contributors**: Showcase your contributions, tell your story, connect with new projects and other contributors, and gain insights into your open source journey. +- [**Empower maintainers and teams**](../docs/maintainers/maintainers-guide.md): Track and showcase your contributions and projects, connect with contributors, collaborate with your team, and gain insights into your open source projects. +- [**Support contributors**](../docs/contributors/contributors-guide.md): Showcase your contributions, tell your story, connect with new projects and other contributors, and gain insights into your open source journey. - [**Highlight success**](../docs/features/highlights.md): Showcase your contributions with our shareable Highlights, inspiring others to embark on their open source journey. -- [**Unlock Insights**](../docs/features/insights.md): Understand the health of your project, track contributions, and make data-driven decisions with OpenSauced Insights. +- [**Unlock Insights**](./features/repo-insights.md): Understand the health of your project, track contributions, and make data-driven decisions with OpenSauced Insights. diff --git a/docs/job-seekers-guide/categorize-contributions.md b/docs/job-seekers-guide/categorize-contributions.md index 00607cd1..cf2beceb 100644 --- a/docs/job-seekers-guide/categorize-contributions.md +++ b/docs/job-seekers-guide/categorize-contributions.md @@ -45,7 +45,7 @@ If you are looking to level up in your role, you should list it in this section | Industry/Area of Interest | [Frontend, Backend, Fullstack, ML, AI, etc.] | | Example Job Links | [Link to desired jobs] | -## How to Match Job Requirements to Your Current Skills +## Matching Job Requirements to Your Current Skills A common mistake for many job seekers is to send out the same resume template to all jobs. But in today's tech market it is important to stand out and tailor your resume to match your skills with the requirements listed. @@ -110,19 +110,19 @@ The [Highlights feature](../features/highlights.md) is the place you can display You can use this feature to help you track the open source contributions that you are most proud of and share your accomplishments with your network. All of 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 highlight you've identified as the most important. -### Using the Lists Feature to Add People You Interacted with During Your Contributions +### Using the Contributor Insight Feature to Follow People -The [Lists feature](../features/lists.md) enables you to categorize, monitor, and analyze different groups of contributors within open source projects. +The [Contributor Insights feature](../features/contributor-insights.md) enables you to categorize, monitor, and analyze different groups of contributors within open source projects. 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, then they can act as referrals and references for jobs. -Lists can also be used to track other people in your network to reach out to about their contributions. +Contributor Insights can also be used to track other people in your network to reach out to about their contributions. -![lists-page](../../static/img/lists-page.svg) +![Contributor Insights page](../../static/img/lists-page.svg) -### Using the Insights Feature to Track the Repositories You Contributed to +### Using the Repository Insights Feature to Track the Repositories You Contributed to -The [Insights feature](../features/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. +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. ![insight-pages-demo](../../static/gif/insight-page-demo.gif) @@ -202,7 +202,7 @@ The Highlights feature allows you to post about your recent open source contribu | Feedback Received/Milestones Achieved | Positive feedback on the elegant design; milestone: merged into main branch. | | **Networking and Professional Development** | | | Contacts Made | Connected with project maintainers and frontend enthusiasts. | -| Insights Gained from Networking | Learned about upcoming trends in frontend development. | +| Repository Insights Gained from Networking | Learned about upcoming trends in frontend development. | | Future Networking Opportunities | Planning to attend the project's monthly virtual meetup. | | **Reflection and Next Steps** | | | Key Takeaways from This Project | Improved skills in component design and collaboration. | diff --git a/docs/job-seekers-guide/introduction.md b/docs/job-seekers-guide/introduction.md index dff1e266..d217c5c7 100644 --- a/docs/job-seekers-guide/introduction.md +++ b/docs/job-seekers-guide/introduction.md @@ -18,4 +18,4 @@ Open Source provides you the opportunity to showcase your code, documentation, c OpenSauced can help you craft an open source profile that is attractive to hiring managers and recruiters and help you land that next role. -In this guide, you will learn how to use OpenSauced features like your personal [Dev Card](../features/dev-card.md), [Highlights](../features/highlights.md), [Lists](../features/lists.md) and [Insights](../features/insights.md) to showcase your open source work and build connections to help you land a job. +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. diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md index 0a68db80..268fd13d 100644 --- a/docs/maintainers/maintainers-guide.md +++ b/docs/maintainers/maintainers-guide.md @@ -12,17 +12,17 @@ keywords: ## Introduction to OpenSauced for Maintainers -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 Insights Pages and Lists with the repositories you choose and the contributors you want to see. +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 Insights Pages and Contributor Insights with the repositories you choose and the contributors you want to see. ## Getting Started 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. -## Insights: Connecting Your Repositories +## Repository Insights: Connecting Your Repositories -OpenSauced Insights provides maintainers with a visual representation of their project's health and contributor engagement. It offers real-time data and analytics to understand contribution patterns, identify key contributors, and measure the project's growth. Insights can help you assess team activity, understand when bottlenecks occur, identify where resource allocation is needed, plan and identify key contributors, understand alumni contributors, or spot emerging trends. +OpenSauced Repository Insights provides maintainers with a visual representation of their project's health and contributor engagement. It offers real-time data and analytics to understand contribution patterns, identify key contributors, and measure the project's growth. Repository Insights can help you assess team activity, understand when bottlenecks occur, identify where resource allocation is needed, plan and identify key contributors, understand alumni contributors, or spot emerging trends. -Insights features allow you to: +The Repository Insights feature allows you to: - track the contributions of a specific team, a specific repository, or a group of repositories, - view the number of pull requests that are open, closed, in draft, and merged, @@ -30,18 +30,18 @@ Insights features allow you to: - identify the top contributors to your project, - identify the current activity level and trends in activity of your contributors. -### Creating a New Insight Page +### Creating a New Repository Insight Page -To connect your repositories, click the "Insights" tab on the dashboard. You will be redirected to a page where you can create your new Insight Page. +To connect your repositories, click the "Insights" tab on the dashboard. You will be redirected to a page where you can create your new Repository Insight Page. -There are two ways to add repositories to your Insight Page: +There are two ways to add repositories to your Repository Insight Page: 1. **Sync GitHub organization**. Syncing your GitHub organization is a good idea for someone who seeks a comprehensive, unified view of your organization's open source project activities and trends, enabling streamlined management, strategic decision-making, and efficient allocation of resources across multiple repositories. 2. **Connect individual repositories**. Connecting individual repositories is a good idea for someone who wants to track the contributions of a specific repository or group of repositories. For example, you might want to track projects you maintain that are not under the same organization, or you may want to track projects that align with your team's objectives. ![sync team gif](../../static/gif/team-sync-insights.gif) -### Using Your Insights Page +### Using Your Repository Insights Page Once you have connected your repositories, you will be redirected to your Insight Page. Here, you will see a dashboard with an overview of the repositories and the contributors who have contributed to them. @@ -53,7 +53,7 @@ The Reports tab allows paid users to filter for more information about their rep #### Repositories -The Repositories tab allows you to view more detailed information on each repository, including Activity, PR Overview, PR Velocity, Spam, Contributors, and activity over the last 30 days. To learn more about these features, see [Understanding Insights Data](understanding-insights.md). +The Repositories tab allows you to view more detailed information on each repository, including Activity, PR Overview, PR Velocity, Spam, Contributors, and activity over the last 30 days. To learn more about these features, see [Understanding Repository Insights Data](understanding-repo-insights.md). ![repositories tab](../../static/img/repos-insights.png) @@ -61,61 +61,64 @@ The Repositories tab allows you to view more detailed information on each reposi The Contributors tab allows you to view more detailed information on each contributor, including Activity, Repositories, the date of their last contribution, Time Zone, and the number of contributions. -To learn more about your contributors, you can select them and add them to a list. +To learn more about your contributors, you can select them and add them to a Contributor Insight Page. ![contributors insight list](../../static/img/contributors-insights.png) -There are two ways to add contributors to a list: +There are two ways to add contributors to a Contributor Insight Page: -1. Create a new list with selected contributors. -2. Add selected contributors to an existing list. +1. Create a new Contributor Insight Page with selected contributors. +2. Add selected contributors to an existing Contributor Insight Page. -## Lists: Connecting with Contributors +## Contributor Insights : Connecting with Contributors -OpenSauced Lists feature allows you to categorize, monitor, and analyze various groups of contributors. You can use Lists to track the contributions of a specific team, a specific repository, or a group of repositories. This feature offers granular insights into each contributor's activities and contributions, helping maintainers to track individual contribution histories, identify active engagement, recognize new or alumni contributors, and compare the performance of different contributors. +OpenSauced Contributor Insights feature allows you to categorize, monitor, and analyze various groups of contributors. You can use Contributor Insights to track the contributions of a specific team, a specific repository, or a group of repositories. This feature offers granular insights into each contributor's activities and contributions, helping maintainers to track individual contribution histories, identify active engagement, recognize new or alumni contributors, and compare the performance of different contributors. -The Lists features allow you to: +The Contributor Insights features allow you to: - track the commits and PRs of the contributors on your list, - filter your contributors by their activity level, including most active, new, and alumni, - view the repositories that your contributors have contributed to, the top programming languages they've used, and their time zones. -### Why Create a List? +### Why Create a Contributor Insight Page? -There are many reasons to create a list, but here's some inspiration to get you started: +There are many reasons to create a Contributor Insight Page, but here's some inspiration to get you started: - **Interacting contributors**: Keep tabs on contributors actively interacting with your repository. - **Organization's developers**: Monitor the contributions and performance of your internal team. -- **VIP contributors**: Highlight and track at least five developers who are key maintainers or significant contributors. +- **VIP contributors**: Highlight and track contributors who you've identifies as key maintainers or significant contributors. - **Sales leads**: Identify contributors whose engagement could potentially be turned into sales opportunities. - **Potential hires**: Observe contributors who exhibit skill and commitment, making them prime candidates for hiring. - **Alumni contributors**: Keep an eye on contributors who have decreased their engagement or left the project. -### Creating a New List +### Creating a New Contributor Insight Page -1. Click the "Lists" tab on the Insights hub to create a new list. You will be redirected to a page where you can create your new list. -2. Click on the "New List" button to start a new list. -3. Give your list a name. -4. Choose your page visibility. You can choose to make your list public or private. By default, it is set to private. -5. Add contributors to your list by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following. +1. Click the + next to Insights in the sidebar to create a new insight page. You will be redirected to a page where you can create your new insight page. + +![New Contributor Insight Page](../../static/img/contrib-insight-new.png) + +2. Click on the "New Contributor Insight" to start a new insight page. +3. Give your page a name. +4. Choose your page visibility. You can choose to make your Contributor Insight Page public or private. By default, it is set to public. +5. Add contributors to your page by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following. ![team sync gif](../../static/gif/team-sync.gif) -## Using Your List +## Using Your Contributor Insight Page -Once you have created your list, you will be redirected to your List Page. Here, you will see a dashboard with an overview of the contributors. +Once you have created your page, you will be redirected to your Contributor Insight Page. Here, you will see a dashboard with an overview of the contributors. There are three tabs that provide you with more information on these repositories: ### Overview -The Overview tab gives you a high-level view of the contributors in your list, including the total number of commits in the last 30 days and the types of contributors on your list: Active, New, and Alumni. +The Overview tab gives you a high-level view of the contributors in your Contributor Insight Page, including the total number of commits in the last 30 days and the types of contributors: Active, New, and Alumni. ### Activity The Activity tab gives you a graph view with more detailed information on each contributor, including the type of activity, repositories they've contributed to, and how they compare to each other. -You can filter your list by All Contributors, Active Contributors, New Contributors, and Alumni Contributors. +You can filter your Contributor Insight Page by All Contributors, Active Contributors, New Contributors, and Alumni Contributors. ![list graph](../../static/img/list-graph.png) @@ -123,7 +126,7 @@ You can filter your list by All Contributors, Active Contributors, New Contribut The Contributors tab gives you the list of the contributors and includes information like activity level, last repository contributed to, the date of their last contribution, time zone, programming languages used, and number of contributions. -To learn more about these features, see [Understanding Lists Data](understanding-lists-data.md). +To learn more about these features, see [Understanding Contributor Insights Data](understanding-contrib-insights.md). ## Highlights: Connecting and Recognizing Contributions diff --git a/docs/maintainers/understanding-lists-data.md b/docs/maintainers/understanding-contrib-insights.md similarity index 89% rename from docs/maintainers/understanding-lists-data.md rename to docs/maintainers/understanding-contrib-insights.md index 482608d3..8354d251 100644 --- a/docs/maintainers/understanding-lists-data.md +++ b/docs/maintainers/understanding-contrib-insights.md @@ -1,23 +1,23 @@ --- -id: understanding-lists -title: "Understanding Lists Data" -sidebar_label: "Understanding Lists Data" +id: understanding-contribs-insights +title: "Understanding Contributor Insights Data" +sidebar_label: "Understanding Contributor Insights Data" keywords: - "maintainers" - "guides" - - "Lists Analysis" + - "Contributor Insights Analysis" - "List Data Exploration" - "Data Organization" - - "Data Insight from Lists" + - "Data Insight from Contributor Insights " - "List Visualization" - - "Data Representation in Lists" + - "Data Representation in Contributor Insights " - "List Data Interpretation" - - "Organizing Data in Lists" + - "Organizing Data in Contributor Insights " --- Once you've created your list of contributors, it's time to understand the data provided. Understanding this data is key to effectively managing your projects and contributors. -## Understanding Lists Contributor Data +## Understanding Contributor Insights Data ### Interpreting Total Commits in the Last 30 Days diff --git a/docs/maintainers/understanding-insights.md b/docs/maintainers/understanding-repo-insights.md similarity index 95% rename from docs/maintainers/understanding-insights.md rename to docs/maintainers/understanding-repo-insights.md index 0237179b..2a34e821 100644 --- a/docs/maintainers/understanding-insights.md +++ b/docs/maintainers/understanding-repo-insights.md @@ -1,7 +1,7 @@ --- -id: understanding-insights -title: "Understanding Insights Data" -sidebar_label: "Understanding Insights Data" +id: understanding-repo-insights +title: "Understanding Repo Insights Data" +sidebar_label: "Understanding Repo Insights Data" keywords: - "maintainers" - "guides" @@ -18,7 +18,7 @@ keywords: 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. -## Understanding Insights Repository Data +## Understanding Repository Insights Data ### Analyzing Contribution Trends @@ -32,7 +32,7 @@ Knowing the status of PRs (open, closed, draft, merged) helps in understanding t Track how quickly PRs are being merged. The average time taken for PRs to merge is a critical metric for understanding the efficiency of the code review and deployment process. Longer PR merge times might signal issues in the review process, resource allocation, or could indicate complex code changes that require more thorough checks. Use this data to set benchmarks and identify opportunities for streamlining your review and integration processes. -## Understanding Insights Contributor Data +## Understanding Repository Insights Contributor Data ### Identifying and Engaging with Key Contributors diff --git a/docs/welcome/faqs.md b/docs/welcome/faqs.md index 0015b166..1d60aabc 100644 --- a/docs/welcome/faqs.md +++ b/docs/welcome/faqs.md @@ -24,7 +24,7 @@ However, sites like [Good First Issues](https://goodfirstissues.com/) and [First ### 2. My contribution does not show up on my OpenSauced profile. How do I fix it? -Create an [Insights Page](https://app.opensauced.pizza/hub/insights) or add your merged pull request to a [Highlight](https://app.opensauced.pizza/feed). +Create a [Repository Insights Page](https://app.opensauced.pizza/hub/insights) or add your merged pull request to a [Highlight](https://app.opensauced.pizza/feed). ### 3. I want to provide feedback on OpenSauced. diff --git a/docs/welcome/glossary.md b/docs/welcome/glossary.md index faad4290..45806bdd 100644 --- a/docs/welcome/glossary.md +++ b/docs/welcome/glossary.md @@ -29,13 +29,9 @@ Activity tracks Pull Requests (PRs) over the last 30 days: A contributor who has not been active on a project in the last 30 days. -## Insights +## Contributor Insights -The Insights feature is a 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. - -## Lists - -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. +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. ## New Contributors @@ -53,3 +49,7 @@ PR Overview tells the story of the Pull Requests (PRs) submitted in the last 30 ## PR Velocity PR Velocity tracks how quickly Pull Requests (PRs) are being merged in by identifying the average time to completion from the request submission. + +## Repository Insights + +The Repository Insights feature is a 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. \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 7b73193e..d2c1b71e 100644 --- a/sidebars.js +++ b/sidebars.js @@ -23,27 +23,27 @@ module.exports = { label: "Features", collapsed: false, items: [ + "features/workspaces", + "features/repo-insights", + "features/contributor-insights", "features/highlights", - "features/insights", "features/dev-card", - "features/lists", - "features/connections", ], }, { type: "category", - label: "Maintainers", + label: "Maintainers Guide to OpenSauced", collapsed: false, items: [ "maintainers/maintainers-guide-to-open-sauced", - "maintainers/understanding-insights", - "maintainers/understanding-lists", + "maintainers/understanding-repo-insights", + "maintainers/understanding-contribs-insights", ], }, { type: "category", - label: "Contributors", - collapsed: false, + label: "Contributors Guide to OpenSauced", + collapsed: true, items: ["contributors/contributors-guide-to-open-sauced"], }, { @@ -55,7 +55,7 @@ module.exports = { { type: "category", label: "Tools", - collapsed: false, + collapsed: true, items: [ "tools/hot-opensauced", "tools/pizza-cli", diff --git a/static/img/access-workspace.png b/static/img/access-workspace.png new file mode 100644 index 00000000..17692056 Binary files /dev/null and b/static/img/access-workspace.png differ diff --git a/static/img/contrib-insight-new.png b/static/img/contrib-insight-new.png new file mode 100644 index 00000000..d7304678 Binary files /dev/null and b/static/img/contrib-insight-new.png differ diff --git a/static/img/workspace-sidebar.png b/static/img/workspace-sidebar.png new file mode 100644 index 00000000..61bfdef7 Binary files /dev/null and b/static/img/workspace-sidebar.png differ diff --git a/static/img/workspace.png b/static/img/workspace.png new file mode 100644 index 00000000..b51acacb Binary files /dev/null and b/static/img/workspace.png differ