From 136ea4fcf02efe5d6ce0d23147911b44db2ebfa1 Mon Sep 17 00:00:00 2001 From: oguntunjiharlimatodunola Date: Fri, 23 Feb 2024 18:37:45 +0100 Subject: [PATCH 01/10] Add information on the graphs in the List feature --- docs/features/lists.md | 75 ++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 72 insertions(+), 3 deletions(-) diff --git a/docs/features/lists.md b/docs/features/lists.md index 5ed0df25..88111ff0 100644 --- a/docs/features/lists.md +++ b/docs/features/lists.md @@ -11,15 +11,49 @@ keywords: - "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. +The OpenSauced 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. +Contributors can use Lists feature to track their own activity, while maintainers can use the feature to manage the community. + +## Lists Features for Contributors and Maintainers +_For Contributors_ + +- **Track Your Impact**: Monitor your commits and pull requests (PRs) across diverse projects, gaining a clear picture of your contributions. + +- **Benchmark Performance**: Compare your activity to others based on metrics like commits, created/reviewed PRs, and issue creation/commenting. + +- **Identify Peers & Alumni**: See who's actively involved, discover new contributors, and reconnect with returning members. + +- **Dive Deeper into Projects**: Explore contributors' repositories and top programming languages, gaining valuable insights into project landscapes. + +- **Understand Time Zones**: Collaborate more effectively with awareness of contributor time zones for streamlined communication. + +_For Maintainers_ + +- **Monitor Project Health**: Track individual commit histories and gain an overall view of contributor activity and engagement. + +- **Identify Key Players**: Easily recognize new contributors, active members, and alumni, enabling you to nurture a thriving community. + +- **Foster Collaboration**: Facilitate smoother collaboration by understanding contributor activity and preferred communication times. + +- **Analyze Trends & Impact**: Gain valuable insights into project trends and contributor performance through detailed metrics analysis. + +- **Optimize Resource Allocation**: Identify areas where resources are needed based on contributor activity and skills. + + ![lists-page](../../static/img/lists-page.svg) -## How to Create a List +## Why Create Lists for Contributors and Maintainers? + +Creating lists for both contributors and maintainers offers a wealth of benefits, enhancing collaboration and building a stronger open-source community. There are many reasons to create a lists, but here are some inspiration to get you started either as a contributor or a maintainer: + +- **Increased Transparency**: Lists promote open communication by providing clear insights into project activity and individual contributions. + +- **Enhanced Collaboration**: Understanding each other's needs and contributions fosters smoother and more effective collaboration. -After logging in, navigate to your [Lists Page](https://app.opensauced.pizza/hub/lists/). +- **Stronger Community**: Recognizing and appreciating contributors builds a more engaged and vibrant community. There are three ways to add a list: @@ -30,4 +64,39 @@ There are three ways to add a list: 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. +## How to Create a List + +After logging in, navigate to your Lists Page. + + +## Creating a New List + +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 or maintainers to your list by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following. + +![Here](https://docs.opensauced.pizza/assets/images/team-sync-09e7e2ab7b54fae335f5b4c40cce94b1.gif). + +## Using Your List + +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 contributions in your list. + +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. + +## 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. + +![Activity Overview](https://docs.opensauced.pizza/assets/images/list-graph-a730e101fea2e18df0d76faed967f4e6.png) + +To learn more about these features, see [Understanding Lists Data](https://docs.opensauced.pizza/maintainers/understanding-lists/). + 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). From fc26c690770f75581534b2f4c4d33405fb2094ab Mon Sep 17 00:00:00 2001 From: oguntunjiharlimatodunola Date: Sat, 24 Feb 2024 09:29:09 +0100 Subject: [PATCH 02/10] Changes made --- docs/features/lists.md | 39 ++++++++++++++++++--------------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/docs/features/lists.md b/docs/features/lists.md index 88111ff0..8fa8e172 100644 --- a/docs/features/lists.md +++ b/docs/features/lists.md @@ -17,43 +17,39 @@ Monitor individual commit histories, track who is actively engaged, identify alu Contributors can use Lists feature to track their own activity, while maintainers can use the feature to manage the community. -## Lists Features for Contributors and Maintainers -_For Contributors_ - -- **Track Your Impact**: Monitor your commits and pull requests (PRs) across diverse projects, gaining a clear picture of your contributions. - -- **Benchmark Performance**: Compare your activity to others based on metrics like commits, created/reviewed PRs, and issue creation/commenting. - -- **Identify Peers & Alumni**: See who's actively involved, discover new contributors, and reconnect with returning members. +![lists-page](../../static/img/lists-page.svg) -- **Dive Deeper into Projects**: Explore contributors' repositories and top programming languages, gaining valuable insights into project landscapes. +## Why Create Lists for Contributors and Maintainers? -- **Understand Time Zones**: Collaborate more effectively with awareness of contributor time zones for streamlined communication. +Creating lists for both contributors and maintainers offers a wealth of benefits, enhancing collaboration and building a stronger open-source community. There are many reasons to create a lists, but here are some inspiration to get you started either as a contributor or a maintainer: _For Maintainers_ -- **Monitor Project Health**: Track individual commit histories and gain an overall view of contributor activity and engagement. +There are many reasons to create a list, but here's some inspiration to get you started: -- **Identify Key Players**: Easily recognize new contributors, active members, and alumni, enabling you to nurture a thriving community. +- **Interacting contributors**: Keep tabs on contributors actively interacting with your repository. -- **Foster Collaboration**: Facilitate smoother collaboration by understanding contributor activity and preferred communication times. +- **Organization's developers**: Monitor the contributions and performance of your internal team. -- **Analyze Trends & Impact**: Gain valuable insights into project trends and contributor performance through detailed metrics analysis. +- **VIP contributors**: Highlight and track at least five developers who are key maintainers or significant contributors. -- **Optimize Resource Allocation**: Identify areas where resources are needed based on contributor activity and skills. +- **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. -![lists-page](../../static/img/lists-page.svg) +- **Alumni contributors**: Keep an eye on contributors who have decreased their engagement or left the project. -## Why Create Lists for Contributors and Maintainers? +_For Contributors_ -Creating lists for both contributors and maintainers offers a wealth of benefits, enhancing collaboration and building a stronger open-source community. There are many reasons to create a lists, but here are some inspiration to get you started either as a contributor or a maintainer: +There are many things you can do with this feature, but here are some ideas to get you started: + +- **Track personal contributions**: If you create a list of your personal contributions, you can track them and see how you're doing over time, as well as get a breakdown of the type of contributions you're making, including commits, created PRs, reviewed PRs, and created issues. -- **Increased Transparency**: Lists promote open communication by providing clear insights into project activity and individual contributions. +- **Learn about what other contributors are doing in open source**: You can learn where other contributors are contributing, what they're working on, and how active they are in the open source community. -- **Enhanced Collaboration**: Understanding each other's needs and contributions fosters smoother and more effective collaboration. +- **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. -- **Stronger Community**: Recognizing and appreciating contributors builds a more engaged and vibrant community. +- **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. There are three ways to add a list: @@ -92,6 +88,7 @@ The Overview tab gives you a high-level view of the contributors in your list, i ## 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. +There's also the Highlights tab that shows any Highlights on OpenSauced that have been made by the contributors on the list. You can filter your list by All Contributors, Active Contributors, New Contributors, and Alumni Contributors. From 433467e66d2caedb8700f7d35af61611293f448d Mon Sep 17 00:00:00 2001 From: oguntunjiharlimatodunola Date: Sun, 25 Feb 2024 19:20:14 +0100 Subject: [PATCH 03/10] Adds update --- docs/features/lists.md | 38 +++++++++++++++++++++++++++++--------- 1 file changed, 29 insertions(+), 9 deletions(-) diff --git a/docs/features/lists.md b/docs/features/lists.md index 8fa8e172..74d300d7 100644 --- a/docs/features/lists.md +++ b/docs/features/lists.md @@ -19,13 +19,9 @@ Contributors can use Lists feature to track their own activity, while maintainer ![lists-page](../../static/img/lists-page.svg) -## Why Create Lists for Contributors and Maintainers? +## Lists for Maintainers -Creating lists for both contributors and maintainers offers a wealth of benefits, enhancing collaboration and building a stronger open-source community. There are many reasons to create a lists, but here are some inspiration to get you started either as a contributor or a maintainer: - -_For Maintainers_ - -There are many reasons to create a list, but here's some inspiration to get you started: +Lists offer a variety of opportunities to track contributors for various reasons, including: - **Interacting contributors**: Keep tabs on contributors actively interacting with your repository. @@ -33,15 +29,15 @@ There are many reasons to create a list, but here's some inspiration to get you - **VIP contributors**: Highlight and track at least five developers who are key maintainers or significant contributors. -- **Sales leads**: Identify contributors whose engagement could potentially be turned into sales opportunities. +- **Your GitHub Teams**: Track the activity of your teams to identify if contributors are still active. For example, if you have members on your triage team, you can see their activity level on your repositories to determine if they're still active enough to participate in that role. - **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. -_For Contributors_ +## Lists for Contributors -There are many things you can do with this feature, but here are some ideas to get you started: +Lists offer contributors a way to gain insight into the world of open source contributions, including: - **Track personal contributions**: If you create a list of your personal contributions, you can track them and see how you're doing over time, as well as get a breakdown of the type of contributions you're making, including commits, created PRs, reviewed PRs, and created issues. @@ -88,8 +84,32 @@ The Overview tab gives you a high-level view of the contributors in your list, i ## 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. + There's also the Highlights tab that shows any Highlights on OpenSauced that have been made by the contributors on the list. +## Highlight Your Open Source Contributions + +The Highlights feature is the place you can display your favorite open source contributions, share the story, and inspire others to join you in your open source journey. For maintainers, it's a great way to showcase your project and the issues that need support and attract new contributors. + +There are currently three types of highlights you can add to your profile: + +- Dev.to blog post +- Pull request +- Issue + +## How to Add a Highlight + +- 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. + +![Walkthrough](https://docs.opensauced.pizza/assets/images/highlight-e3a2da2446fe91467a31d225755bf40a.gif) + +For more examples of highlights, go to the [OpenSauced Highlights feed](https://intro.opensauced.pizza/#/06-the-secret-sauce?id=effectively-highlight-your-contributions). + + + You can filter your list by All Contributors, Active Contributors, New Contributors, and Alumni Contributors. ![Activity Overview](https://docs.opensauced.pizza/assets/images/list-graph-a730e101fea2e18df0d76faed967f4e6.png) From bef5f3c43f2a8c304b08228e273403743800dd78 Mon Sep 17 00:00:00 2001 From: oguntunjiharlimatodunola Date: Fri, 1 Mar 2024 15:21:37 +0100 Subject: [PATCH 04/10] resolce conflict --- docs/features/lists.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/features/lists.md b/docs/features/lists.md index 74d300d7..30979d5f 100644 --- a/docs/features/lists.md +++ b/docs/features/lists.md @@ -93,9 +93,9 @@ The Highlights feature is the place you can display your favorite open source co There are currently three types of highlights you can add to your profile: -- Dev.to blog post -- Pull request -- Issue +- Dev.to blog post. +- Pull request. +- Issue. ## How to Add a Highlight @@ -116,4 +116,4 @@ You can filter your list by All Contributors, Active Contributors, New Contribut To learn more about these features, see [Understanding Lists Data](https://docs.opensauced.pizza/maintainers/understanding-lists/). -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 our [Sync Your GitHub Team in our FAQs](../welcome/faqs.md#sync-your-github-team). \ No newline at end of file From b29e9cf52d7170129c7322ba00549d1437c51625 Mon Sep 17 00:00:00 2001 From: oguntunjiharlimatodunola Date: Fri, 1 Mar 2024 17:27:34 +0100 Subject: [PATCH 05/10] Adds lists-page --- docs/features/lists.md | 119 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 119 insertions(+) create mode 100644 docs/features/lists.md diff --git a/docs/features/lists.md b/docs/features/lists.md new file mode 100644 index 00000000..30979d5f --- /dev/null +++ b/docs/features/lists.md @@ -0,0 +1,119 @@ +--- +id: lists +title: "Organize and Monitor Your Contributors" +sidebar_label: "Lists" +keywords: + - "lists" + - "contributors" + - "organize" + - "Monitor Contributors" + - "Organize Contributors" + - "Contributor Lists Management" +--- + +The OpenSauced 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. + +Contributors can use Lists feature to track their own activity, while maintainers can use the feature to manage the community. + +![lists-page](../../static/img/lists-page.svg) + +## Lists for Maintainers + +Lists offer a variety of opportunities to track contributors for various reasons, including: + +- **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. + +- **Your GitHub Teams**: Track the activity of your teams to identify if contributors are still active. For example, if you have members on your triage team, you can see their activity level on your repositories to determine if they're still active enough to participate in that role. + +- **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. + +## Lists for Contributors + +Lists offer contributors a way to gain insight into the world of open source contributions, including: + +- **Track personal contributions**: If you create a list of your personal contributions, you can track them and see how you're doing over time, as well as get a breakdown of the type of contributions you're making, including commits, created PRs, reviewed PRs, and created issues. + +- **Learn about what other contributors are doing in open source**: You can learn where other contributors are contributing, what they're working on, and how active they are in the open source community. + +- **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. + +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. + +## How to Create a List + +After logging in, navigate to your Lists Page. + + +## Creating a New List + +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 or maintainers to your list by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following. + +![Here](https://docs.opensauced.pizza/assets/images/team-sync-09e7e2ab7b54fae335f5b4c40cce94b1.gif). + +## Using Your List + +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 contributions in your list. + +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. + +## 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. + +There's also the Highlights tab that shows any Highlights on OpenSauced that have been made by the contributors on the list. + +## Highlight Your Open Source Contributions + +The Highlights feature is the place you can display your favorite open source contributions, share the story, and inspire others to join you in your open source journey. For maintainers, it's a great way to showcase your project and the issues that need support and attract new contributors. + +There are currently three types of highlights you can add to your profile: + +- Dev.to blog post. +- Pull request. +- Issue. + +## How to Add a Highlight + +- 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. + +![Walkthrough](https://docs.opensauced.pizza/assets/images/highlight-e3a2da2446fe91467a31d225755bf40a.gif) + +For more examples of highlights, go to the [OpenSauced Highlights feed](https://intro.opensauced.pizza/#/06-the-secret-sauce?id=effectively-highlight-your-contributions). + + + +You can filter your list by All Contributors, Active Contributors, New Contributors, and Alumni Contributors. + +![Activity Overview](https://docs.opensauced.pizza/assets/images/list-graph-a730e101fea2e18df0d76faed967f4e6.png) + +To learn more about these features, see [Understanding Lists Data](https://docs.opensauced.pizza/maintainers/understanding-lists/). + +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). \ No newline at end of file From 30a994e1ffc21ed409ca9cc2d0890431b00832e3 Mon Sep 17 00:00:00 2001 From: oguntunjiharlimatodunola Date: Tue, 2 Apr 2024 11:25:14 +0100 Subject: [PATCH 06/10] Adds contributor insights --- docs/features/contributor-insights.md | 46 ++++++++++++++++++++++----- 1 file changed, 38 insertions(+), 8 deletions(-) diff --git a/docs/features/contributor-insights.md b/docs/features/contributor-insights.md index 8358a942..5f64a8d1 100644 --- a/docs/features/contributor-insights.md +++ b/docs/features/contributor-insights.md @@ -17,17 +17,47 @@ Monitor individual commit histories, track who is actively engaged, identify alu ![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/). +## Contributor Insight for Maintainers + +Contributor insight offer a variety of opportunities to track contributors for various reasons, including: + +- **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. + +- **Your GitHub Teams**: Track the activity of your teams to identify if contributors are still active. For example, if you have members on your triage team, you can see their activity level on your repositories to determine if they're still active enough to participate in that role. + +- **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. + -There are three ways to add a list: +## Contributor Insight for Contributors -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. +Contributor insight offer contributors a way to gain insight into the world of open source contributions, including: + +- **Track personal contributions**: If you create a contibutor insight of your personal contributions, you can track them and see how you're doing over time, as well as get a breakdown of the type of contributions you're making, including commits, created PRs, reviewed PRs, and created issues. + +- **Learn about what other contributors are doing in open source**: You can learn where other contributors are contributing, what they're working on, and how active they are in the open source community. + +- **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. + +There are Three ways to add contributors to track: + +1. **Search for Contributors**: Search for ontributors from repositories in your workspace. +2. **Import Contribuors**: Paste a list of contributors to track on yor workspace. +3. **Sync GitHub Following**: Import users that follow from contributors. + +Once your contributor insight is created, you'll be able to see an overview of all the contributors, a graph of their activity, and a detailed breakdown of the contributors. + +## How to Create a Contributor Insight Page -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. +After logging in, navigate to your OpenSauced workspace. Click on the navigation bar of your workspace home page. Click on the plus sign beside insight. Two options will display, which are ; New repository insight and New contributor insight. Click on the New contributor insight. Then add the contributors by searching for their names or import contributors by syncing your GitHub following. + [Contributor Insights Page](https://app.opensauced.pizza/hub/lists/). 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). From 5e745f4a337965ed16f3b59310ab87d723eb0ede Mon Sep 17 00:00:00 2001 From: Lymah123 Date: Tue, 2 Apr 2024 16:26:08 +0100 Subject: [PATCH 07/10] Delete docs/features/lists.md --- docs/features/lists.md | 119 ----------------------------------------- 1 file changed, 119 deletions(-) delete mode 100644 docs/features/lists.md diff --git a/docs/features/lists.md b/docs/features/lists.md deleted file mode 100644 index 30979d5f..00000000 --- a/docs/features/lists.md +++ /dev/null @@ -1,119 +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 OpenSauced 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. - -Contributors can use Lists feature to track their own activity, while maintainers can use the feature to manage the community. - -![lists-page](../../static/img/lists-page.svg) - -## Lists for Maintainers - -Lists offer a variety of opportunities to track contributors for various reasons, including: - -- **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. - -- **Your GitHub Teams**: Track the activity of your teams to identify if contributors are still active. For example, if you have members on your triage team, you can see their activity level on your repositories to determine if they're still active enough to participate in that role. - -- **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. - -## Lists for Contributors - -Lists offer contributors a way to gain insight into the world of open source contributions, including: - -- **Track personal contributions**: If you create a list of your personal contributions, you can track them and see how you're doing over time, as well as get a breakdown of the type of contributions you're making, including commits, created PRs, reviewed PRs, and created issues. - -- **Learn about what other contributors are doing in open source**: You can learn where other contributors are contributing, what they're working on, and how active they are in the open source community. - -- **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. - -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. - -## How to Create a List - -After logging in, navigate to your Lists Page. - - -## Creating a New List - -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 or maintainers to your list by searching for their GitHub username, syncing your GitHub Team, or importing your GitHub Following. - -![Here](https://docs.opensauced.pizza/assets/images/team-sync-09e7e2ab7b54fae335f5b4c40cce94b1.gif). - -## Using Your List - -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 contributions in your list. - -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. - -## 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. - -There's also the Highlights tab that shows any Highlights on OpenSauced that have been made by the contributors on the list. - -## Highlight Your Open Source Contributions - -The Highlights feature is the place you can display your favorite open source contributions, share the story, and inspire others to join you in your open source journey. For maintainers, it's a great way to showcase your project and the issues that need support and attract new contributors. - -There are currently three types of highlights you can add to your profile: - -- Dev.to blog post. -- Pull request. -- Issue. - -## How to Add a Highlight - -- 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. - -![Walkthrough](https://docs.opensauced.pizza/assets/images/highlight-e3a2da2446fe91467a31d225755bf40a.gif) - -For more examples of highlights, go to the [OpenSauced Highlights feed](https://intro.opensauced.pizza/#/06-the-secret-sauce?id=effectively-highlight-your-contributions). - - - -You can filter your list by All Contributors, Active Contributors, New Contributors, and Alumni Contributors. - -![Activity Overview](https://docs.opensauced.pizza/assets/images/list-graph-a730e101fea2e18df0d76faed967f4e6.png) - -To learn more about these features, see [Understanding Lists Data](https://docs.opensauced.pizza/maintainers/understanding-lists/). - -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). \ No newline at end of file From ada6803e495ea3768c533631ac2ca175e90f3b38 Mon Sep 17 00:00:00 2001 From: Lymah123 Date: Tue, 2 Apr 2024 16:33:00 +0100 Subject: [PATCH 08/10] Update contributor-insights.md --- docs/features/contributor-insights.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/features/contributor-insights.md b/docs/features/contributor-insights.md index 0cf5e8fa..f40c4917 100644 --- a/docs/features/contributor-insights.md +++ b/docs/features/contributor-insights.md @@ -18,7 +18,6 @@ Monitor individual commit histories, track who is actively engaged, identify alu ![Contributor Insights Page](../../static/img/lists-page.svg) - ## Contributor Insight for Maintainers Contributor insight offer a variety of opportunities to track contributors for various reasons, including: @@ -66,18 +65,14 @@ After logging in, navigate to your OpenSauced workspace. Click on the navigation [Contributor Insights Page](https://app.opensauced.pizza/hub/lists/). 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). -======= + 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 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. -:::tip - 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. -::: - By default, your Contributor Insight Page is public. If your Contributor Insight Page is private (a PRO plan feature), only those with access to your Workspace will be able to view it. From f7d387be24c45162820d87ec7e9fb90189a8bdb3 Mon Sep 17 00:00:00 2001 From: oguntunjiharlimatodunola Date: Wed, 3 Apr 2024 19:20:08 +0100 Subject: [PATCH 09/10] adds contributor insights --- docs/features/contributor-insights.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/features/contributor-insights.md b/docs/features/contributor-insights.md index 5f64a8d1..91b94caf 100644 --- a/docs/features/contributor-insights.md +++ b/docs/features/contributor-insights.md @@ -57,7 +57,15 @@ Once your contributor insight is created, you'll be able to see an overview of a ## How to Create a Contributor Insight Page -After logging in, navigate to your OpenSauced workspace. Click on the navigation bar of your workspace home page. Click on the plus sign beside insight. Two options will display, which are ; New repository insight and New contributor insight. Click on the New contributor insight. Then add the contributors by searching for their names or import contributors by syncing your GitHub following. +After logging in, navigate to your OpenSauced workspace. +Follow these steps: + +- Click on the navigation bar of your workspace home page. +- Click on the plus sign beside insight. +- Two options will display, which are ; +- New repository insight and New contributor insight. +- Click on the New contributor insight. +- Then add the contributors by searching for their names or import contributors by syncing your GitHub following. [Contributor Insights Page](https://app.opensauced.pizza/hub/lists/). 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). From f1bc7d8879242d91e62eef36520f31bf5b01cf43 Mon Sep 17 00:00:00 2001 From: oguntunjiharlimatodunola Date: Sun, 14 Apr 2024 17:29:27 +0100 Subject: [PATCH 10/10] adds changes --- docs/features/contributor-insights.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/features/contributor-insights.md b/docs/features/contributor-insights.md index 0e00ed1c..f958387c 100644 --- a/docs/features/contributor-insights.md +++ b/docs/features/contributor-insights.md @@ -32,10 +32,7 @@ Contributor insight offer a variety of opportunities to track contributors for v - **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. - - -After logging in, navigate to "Insights" in the sidebar. Click the "+" next to it to be presented with options, and select "New Contributor Insight." +- **Alumni contributors**: Keep an eye on contributors who have decreased their engagement or left the project ## Contributor Insight for Contributors @@ -49,8 +46,6 @@ Contributor insight offer contributors a way to gain insight into the world of o - **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. - There are Three ways to add contributors to track: 1. **Search for Contributors**: Search for ontributors from repositories in your workspace. @@ -80,6 +75,8 @@ If you're having trouble syncing your Organization or Team, check out our [Sync 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. +- :::tip + 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. By default, your Contributor Insight Page is public. If your Contributor Insight Page is private (a PRO plan feature), only those with access to your Workspace will be able to view it.