From 4a9aab713bbffa482a15de7fbd9be8092aab5f37 Mon Sep 17 00:00:00 2001 From: Hichem Fantar Date: Tue, 19 Nov 2024 14:41:04 +0100 Subject: [PATCH] fix: correct formatting and punctuation in documentation files --- docs/community/100-days-of-oss.md | 6 ++-- docs/contributing/code-of-conduct.md | 2 +- .../how-to-add-your-post.md | 12 ++++--- .../technical/resolve-merge-conflicts.md | 1 + docs/contributors/contributors-guide.md | 2 +- docs/features/contributor-insights.md | 4 +-- docs/features/repo-insights.md | 4 +-- docs/features/repo-pages.md | 34 +++++++++---------- docs/features/star-search.md | 10 +++--- docs/features/workspaces.md | 7 ++-- docs/maintainers/maintainers-guide.md | 4 +-- .../categorize-contributions.md | 2 +- .../students-guide/students-guide.md | 7 ++-- docs/opensauced-packages/semantic-release.md | 2 +- docs/tools/chrome-extension/highlights.md | 2 +- docs/tools/pizza-cli/codeowners.md | 9 ++++- docs/tools/pizza-cli/pizza-action.md | 2 +- docs/tools/pizza-cli/pizza-cli.md | 4 ++- docs/welcome/faqs.md | 4 +-- docs/welcome/glossary.md | 6 ++-- src/css/custom.css | 6 ++-- 21 files changed, 68 insertions(+), 62 deletions(-) diff --git a/docs/community/100-days-of-oss.md b/docs/community/100-days-of-oss.md index 5b79f335..417c8766 100644 --- a/docs/community/100-days-of-oss.md +++ b/docs/community/100-days-of-oss.md @@ -72,9 +72,9 @@ Your OpenSauced Profile, includes your DevCard, which is a great way to track yo #### How to check your OSCR -Go to your OpenSauced Profile. For example, https://app.opensauced.pizza/u/bekahhw. You can also check out [this contributor insight page](https://app.opensauced.pizza/workspaces/cff3f17b-f052-4686-85af-72971009136b/contributor-insights/545c756a-39e0-4361-b516-9610cb413959/overview) to see the members of our 2024 cohort. +Go to your OpenSauced Profile. For [example](https://app.opensauced.pizza/u/bekahhw). You can also check out [this contributor insight page](https://app.opensauced.pizza/workspaces/cff3f17b-f052-4686-85af-72971009136b/contributor-insights/545c756a-39e0-4361-b516-9610cb413959/overview) to see the members of our 2024 cohort. -Remember, there's value in knowing the story behind the numbers. When you share your DevCard, tell the story behind your number. +Remember, there's value in knowing the story behind the numbers. When you share your DevCard, tell the story behind your number. [![DevCard](../../static/img/DevCard.png)](https://app.opensauced.pizza/u/bekahhw/card) @@ -94,7 +94,7 @@ To make the most of your #100DaysOfOSS journey, here are some additional resourc If you're ready to start your #100DaysOfOSS journey, here are some tips to help you get started: -- **Find a project:** Explore the [OpenSauced](https://opensauced.pizza/) website to find a project that interests you. +- **Find a project:** Explore the [OpenSauced](https://opensauced.pizza/) website to find a project that interests you. - **Take our Intro To Open Source course:** If you're new to open source, we recommend taking our [Intro to Open Source course](https://opensauced.pizza/learn/#/) to learn more about open source and how to get started. - **Record your journey:** You will learn a lot as you navigate this challenge, so we highly recommend using our [#100DaysOfOSS journal template](https://github.com/open-sauced/100-days-of-oss-template) on GitHub or [Notion](https://www.notion.so/a0m0rajab/100-Days-Of-Open-Source-2615e66772e14152897002e348c5f1bc?pvs=13) to help you reflect. Remember, this is _your_ journey, so feel free to customize them however you like. - **Check our Contributors Guide:** If you're new to contributing to open source, we recommend checking out our [Contributors Guide to OpenSauced](https://opensauced.pizza/docs/contributors/contributors-guide-to-open-sauced/) to learn more about the process and best practices. diff --git a/docs/contributing/code-of-conduct.md b/docs/contributing/code-of-conduct.md index d973ce3a..eb32dd33 100644 --- a/docs/contributing/code-of-conduct.md +++ b/docs/contributing/code-of-conduct.md @@ -53,7 +53,7 @@ Representation of a project may be further defined and clarified by project main ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hello@briandouglas.me. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [hello@briandouglas.me](mailto:hello@briandouglas.me). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. diff --git a/docs/contributing/opensauced-writers-guide/how-to-add-your-post.md b/docs/contributing/opensauced-writers-guide/how-to-add-your-post.md index 35f175cd..622fedda 100644 --- a/docs/contributing/opensauced-writers-guide/how-to-add-your-post.md +++ b/docs/contributing/opensauced-writers-guide/how-to-add-your-post.md @@ -22,6 +22,7 @@ Please be sure to add `page: true` to your author entry to generate your author ::: **Example:** + ```yaml BekahHW: name: Bekah Hawrot Weigel @@ -50,14 +51,12 @@ All authors should include their name and an image URL. The title, URL, and emai If you do want to include a URL, you can include your OpenSauced profile, X, LinkedIn, personal website, etc. - ## Adding Blog Posts To publish in the blog, create a Markdown file within the blog directory. Note that we have subdirectories for each year, so writers should add their posts to the folder that corresponds with the year. **Example Path:** `/blog/2024/06-03-welcome-opensauced.md` - :::info You'll notice that many of the files include the year. These were created before we started using the year subdirectories. Either way works, but we're moving towards the year subdirectories for organization and omitting the year in the file name. @@ -65,6 +64,7 @@ You'll notice that many of the files include the year. These were created before ::: **Markdown Example:** + ```markdown docs/blog/2024/06-03-welcome-opensauced.md --- @@ -99,6 +99,7 @@ The front matter is the metadata at the top of the Markdown file. It includes th authors:[BekahHW, nickytonline] --- ``` + - **tags:** Tags are used to categorize the blog post. They should be lowercase and separated by commas and highlight the main topics of the blog post. - **hide_table_of_contents:** This is a boolean value that determines whether the table of contents will be displayed. If you want to hide the table of contents, set it to `true`. @@ -106,9 +107,10 @@ authors:[BekahHW, nickytonline] The blog's index page (a custom path for OpenSauced at `/community-resources`) is the blog list page, where all blog posts are collectively displayed. -Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown. +Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown. **Markdown Example:** + ```markdown website/blog/my-post.md --- @@ -124,8 +126,8 @@ But anything from here on down will not be. ### Image Usage -We are not going to use images in the front matter. The rest of the post should be in markdown format. +We are not going to use images in the front matter. The rest of the post should be in markdown format. If you want to include images within your post, please use only images that directly relate to the content of the post. If you need to add an image to the repository (rather than linking from somewhere else), you can add it to the `/static` directory in the `gif` or `img` subdirectory. -By following these guidelines, you will ensure consistency and ease of maintenance across our blog posts. Happy writing! \ No newline at end of file +By following these guidelines, you will ensure consistency and ease of maintenance across our blog posts. Happy writing! diff --git a/docs/contributing/technical/resolve-merge-conflicts.md b/docs/contributing/technical/resolve-merge-conflicts.md index 9545e801..b5a0ffc9 100644 --- a/docs/contributing/technical/resolve-merge-conflicts.md +++ b/docs/contributing/technical/resolve-merge-conflicts.md @@ -46,6 +46,7 @@ cd project-name ```bash git remote add upstream https://github.com/upstream-username/upstream-repository.git ``` + 3. Pull the latest changes from the `upstream`. ```bash diff --git a/docs/contributors/contributors-guide.md b/docs/contributors/contributors-guide.md index 96375605..2fe93a1f 100644 --- a/docs/contributors/contributors-guide.md +++ b/docs/contributors/contributors-guide.md @@ -42,7 +42,7 @@ Your profile is a great resource for showcasing your contributions and sharing y On your profile, you will see the "Highlights" tab, which you can learn more about [in this section](#highlights-connecting-and-recognizing-contributions), and two other tabs: -- **Contributions**: This tab includes a graph showing the number of PRs you have opened, [the velocity of your PRs](../welcome/glossary.md#pr-velocity), and the number of repositories you have contributed to. +- **Contributions**: This tab includes a graph showing the number of PRs you have opened, [the velocity of your PRs](../welcome/glossary.md#pr-velocity), and the number of repositories you have contributed to. Underneath the graph is a "Latest PRs" chart, which shows a list of current and recent PRs. There is also an option to view the user's latest issue comments. The contributions tab is helpful if you want to showcase a steady and consistent open source contribution experience. diff --git a/docs/features/contributor-insights.md b/docs/features/contributor-insights.md index e0fd8249..30afd7b4 100644 --- a/docs/features/contributor-insights.md +++ b/docs/features/contributor-insights.md @@ -44,7 +44,7 @@ By default, your Contributor Insight Page is public. If your Contributor Insight On your Contributor Insight Page, you'll see that each contributor is assigned an [OSCR](../welcome/glossary.md#oscr). The OSCR is a metric to evaluate the engagement and impact of contributors across the entire open source ecosystem. This score aims to give insight into a contributor's involvement and the value they bring to open source communities as a whole. -The OSCR takes into account various factors related to all of the contributor's activity and the quality of their contributions in open source. +The OSCR takes into account various factors related to all of the contributor's activity and the quality of their contributions in open source. :::info OSCRs are calculated on a rolling 90-day basis across all of a contributor's activity and are out of 300 total points. This means the score reflects recent activity and engagement, providing a current snapshot of a contributor's open source involvement rather than a lifetime aggregate. @@ -61,4 +61,4 @@ Here are some of the ways, the OSCR can be used: - Tracking contributor growth over time - Encouraging sustained participation in open source -OSCRs are designed to be a helpful tool in understanding current open source dynamics, but should be considered alongside other factors when evaluating contributors or projects. \ No newline at end of file +OSCRs are designed to be a helpful tool in understanding current open source dynamics, but should be considered alongside other factors when evaluating contributors or projects. diff --git a/docs/features/repo-insights.md b/docs/features/repo-insights.md index 5a3759e5..edabae9d 100644 --- a/docs/features/repo-insights.md +++ b/docs/features/repo-insights.md @@ -12,7 +12,7 @@ keywords: - "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 open source project's health and contributions. From contribution trends to community health, OpenSauced Repository Insights helps you make data-driven decisions that align with your goals. It's not just about numbers; it's about providing data to help you make decisions that can define your approach to open source and tell the story of your project or contribution journey. +The Repository Insights feature is your one-stop solution for understanding the pulse of your open source projects and contributions. This feature is designed to provide a comprehensive view of open source project's health and 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) @@ -60,4 +60,4 @@ This method gives view-only access to your Repository Insights Page. 3. On the top right, click the "Share" button to copy the Repository Insight Page URL to the clipboard. 4. Share the URL with your team members. -By default, your Repository Insights are public. If you want to make your Repository Insights private, you can change it in the settings. \ No newline at end of file +By default, your Repository Insights are public. If you want to make your Repository Insights private, you can change it in the settings. diff --git a/docs/features/repo-pages.md b/docs/features/repo-pages.md index 919c7ee9..3f9114d1 100644 --- a/docs/features/repo-pages.md +++ b/docs/features/repo-pages.md @@ -25,7 +25,7 @@ There are a couple of ways to access a repository page: 1. **From Repository Insights Pages**: If you're already on the Repository Insights Page, you can click on the repository name to view the repository page. 2. **From the search bar**: You can search for a repository by entering the repository name in the search bar. Once you find the repository you're looking for, click on the repository name to view the repository page. -3. **Directly from the URL**: You can also access a repository page directly by entering the URL in your web browser: +3. **Directly from the URL**: You can also access a repository page directly by entering the URL in your web browser: ```text https://app.opensauced.pizza/s/{org}/{repo} @@ -47,7 +47,7 @@ The charts on our repository pages offer a visual representation of key project - **Contributors Overview**: Our bar chart shows contributions by internal, new, and recurring contributors, exibiting the distribution of contributions and the project's ability to attract new contributors. - **[Lottery Factor](../welcome/glossary.md#lottery-factor)**: This unique metric highlights the dependency on key contributors. A project is considered vulnerable if 2 or fewer contributors account for 50% or more of the project's contributions. This indicates a potential risk if one of these contributors leaves the project. -- **[YOLO Coders](../welcome/glossary.md#yolo-coders)**: This metric identifies contributors who push changes directly to the default branch without creating a pull request or seeking community feedback. +- **[YOLO Coders](../welcome/glossary.md#yolo-coders)**: This metric identifies contributors who push changes directly to the default branch without creating a pull request or seeking community feedback. - **Contributor Confidence**: This metric predicts the likelihood that users who star or fork a repository will return to make contributions. A higher confidence score indicates a greater probability of these users actively engaging with the repository. - **OSSF Scorecard**: A standardized metric developed by the Open Source Security Foundation to evaluate the security practices of open source projects based on a set of security criteria. These criteria cover various aspects of project maintenance and security practices. The resulting score provides a quick overview of the project's adherence to security best practices. - **Issue Resolution Trends**: Our line graphs display the number of issues opened versus those closed within specified periods, offering insights into the effectiveness of problem resolution and how issue volume changes over time. @@ -56,7 +56,6 @@ The charts on our repository pages offer a visual representation of key project You can use the time range filter to view the number of stars and forks over different periods, such as the last 7 days, month, or the last year. - ### Insights into Contributor Confidence
@@ -66,19 +65,19 @@ You can use the time range filter to view the number of stars and forks over dif We calculate Contributor Confidence as a percentage over a specific time period (usually 30 days). Here’s what we look at: - - **Starred Repositories**: We check if people who starred a repository have contributed to other repositories during the same timeframe. If they have, we see if they also contributed to the starred repository itself. - - **Forked Repositories**: Similar to starred repositories, we check if people who forked a repository have contributed elsewhere recently. We then see if they made a pull request or other contribution to the forked repository. + - **Starred Repositories**: We check if people who starred a repository have contributed to other repositories during the same timeframe. If they have, we see if they also contributed to the starred repository itself. + - **Forked Repositories**: Similar to starred repositories, we check if people who forked a repository have contributed elsewhere recently. We then see if they made a pull request or other contribution to the forked repository. #### Weighting the Score - - **Forks**: Forking a repository generally indicates a stronger intent to contribute compared to just starring it. So forks tend to have a slightly higher weighting in the confidence score. - - **Direct Contributions**: If someone actually makes a contribution to the repository in question, their confidence score for that specific repository becomes 100% (the highest weight). + - **Forks**: Forking a repository generally indicates a stronger intent to contribute compared to just starring it. So forks tend to have a slightly higher weighting in the confidence score. + - **Direct Contributions**: If someone actually makes a contribution to the repository in question, their confidence score for that specific repository becomes 100% (the highest weight). #### Why is it Useful? Understanding Contributor Confidence can help you gauge the health of a repository and its community. Here are a few ways you can interpret the score: - - A **high Contributor Confidence score (e.g., 37-50%)** suggests a welcoming and active repository where your contributions are likely to be seen and valued. + - A **high Contributor Confidence score (e.g., 37-50%)** suggests a welcoming and active repository where your contributions are likely to be seen and valued. - A **low score (e.g., 1-3%)** might indicate it’s harder for outside contributors to contribute. - A **score in the range of 30-50%** often indicates a healthy and active project. - An **exceptionally high score (above 40%)** could have different interpretations depending on the project. For very popular repositories, it might still reflect a strong community. For smaller projects, it could suggest a lower barrier to entry that might lead to a high volume of low-quality contributions or unfinished work. @@ -100,21 +99,20 @@ You can find out more about how the OSSF Scorecard works and how to interpret th The Contributor Dashboard offers a comprehensive view of all contributors, showcasing the frequency and size of each person’s contributions. It also includes each active contributors [OSCR](../welcome/glossary.md#oscr). - ### The OSCR
The Open Source Contributor Rating (OSCR) is a metric designed to evaluate the quality, confidence, and sway of a contributor's work in open source projects. -#### How it works: +#### How it works The OSCR is calculated using a combination of factors, including: - - **Contributor Confidence**: Assesses how likely a contributor is to continue engaging with projects. - - **Contributor Quality**: Evaluates the overall quality of contributions. - - **Sway**: Measures the contributor's ability to engage with and influence the community through conversations. +- **Contributor Confidence**: Assesses how likely a contributor is to continue engaging with projects. +- **Contributor Quality**: Evaluates the overall quality of contributions. +- **Sway**: Measures the contributor's ability to engage with and influence the community through conversations. -##### How it can be used: +##### How it can be used - **For maintainers**: Identify key contributors and potential collaborators. - **For contributors**: Gauge your impact and areas for improvement as well as track your progress in open source projects. @@ -123,8 +121,6 @@ The OSCR is calculated using a combination of factors, including:
- - Currently, only publicly available repositories on GitHub can be viewed through repository pages. ## Create a Workspace from SBOM @@ -148,7 +144,7 @@ Currently, this feature is only available for projects with a package.json file.
-SBOM Workspaces offer significant benefits for managing and securing software projects by providing a detailed inventory of all software components. By leveraging SBOM workspaces, organizations can enhance their software supply chain security and ensure compliance with industry standards. +SBOM Workspaces offer significant benefits for managing and securing software projects by providing a detailed inventory of all software components. By leveraging SBOM workspaces, organizations can enhance their software supply chain security and ensure compliance with industry standards. Here are the key advantages of using SBOM workspaces: @@ -172,6 +168,8 @@ Tracking SBOMs through OpenSauced workspaces offers several advantages: By leveraging the Workspace from SBOM feature, you can streamline your software development process, enhance security, and maintain better control over your project's dependencies. For a comprehensive understanding of SBOMs and their importance in software security and supply chain risk management, please refer to the following authoritative sources: + - [National Institute of Standards and Technology (NIST)](https://www.nist.gov/itl/executive-order-14028-improving-nations-cybersecurity/software-security-supply-chains-software-1) - [Cybersecurity and Infrastructure Security Agency (CISA)](https://www.cisa.gov/sbom) -
\ No newline at end of file + +
diff --git a/docs/features/star-search.md b/docs/features/star-search.md index db64119d..9c1e2e0a 100644 --- a/docs/features/star-search.md +++ b/docs/features/star-search.md @@ -48,14 +48,14 @@ keywords: ### FAQs - **Can I continue conversations with StarSearch?** - - Not yet, but stay tuned! + - Not yet, but stay tuned! - **Can I access my search history?** - - This feature is currently not available, but we plan to include it in future updates. + - This feature is currently not available, but we plan to include it in future updates. - **What time range does StarSearch cover?** - - StarSearch is most accurate from March 1, 2024. + - StarSearch is most accurate from March 1, 2024. - **Is StarSearch always right?** - - StarSearch is an AI tool and may not always be accurate. We recommend verifying the information. + - StarSearch is an AI tool and may not always be accurate. We recommend verifying the information. ## Feedback -Your feedback helps us improve StarSearch. If you have any suggestions or questions, please create a [discussion post](https://github.com/orgs/open-sauced/discussions/categories/general-feedback-or-bugs) or open an [issue](https://github.com/open-sauced/app/issues). You can also use the thumbs-up or thumbs-down buttons on the StarSearch page to let us know if the information was helpful. \ No newline at end of file +Your feedback helps us improve StarSearch. If you have any suggestions or questions, please create a [discussion post](https://github.com/orgs/open-sauced/discussions/categories/general-feedback-or-bugs) or open an [issue](https://github.com/open-sauced/app/issues). You can also use the thumbs-up or thumbs-down buttons on the StarSearch page to let us know if the information was helpful. diff --git a/docs/features/workspaces.md b/docs/features/workspaces.md index 5914b58a..63d5101e 100644 --- a/docs/features/workspaces.md +++ b/docs/features/workspaces.md @@ -54,7 +54,7 @@ Within the repositories dashboard, you can view the following metrics, which are #### Activity Dashboard -The Activity Dashboard provides a centralized view of recent activity across repositories, including detailed tables for Pull Requests (PRs) and Issues. These tables offer insights into ongoing contributions, bug fixes, feature requests, and more. +The Activity Dashboard provides a centralized view of recent activity across repositories, including detailed tables for Pull Requests (PRs) and Issues. These tables offer insights into ongoing contributions, bug fixes, feature requests, and more. ##### Pull Requests Table @@ -108,13 +108,12 @@ When you use StarSearch within a Workspace, you're essentially treating that Wor
Workspace Prompt Suggestions -- What are the types of pull requests @contributor has worked on? +- What are the types of pull requests @contributor has worked on? - Who is writing issues in these repositories? - Who commits directly to the main branch? - Who are my top pull request contributors?
- ## How to Share a Workspace You can share your Workspace with others by copying the URL and sending it to them. If your Workspace is private, only those with access to the Workspace will be able to view it. @@ -123,7 +122,7 @@ You can share your Workspace with others by copying the URL and sending it to th Team Workspaces are designed to help teams collaborate on and understand open source projects. Team Workspaces are public by default. However, you can switch it to private in your settings so only team members can view the Workspace. -By upgrading to a team Workspace, you'll have unlimited Contributor and Repository Insights, as well as the ability to toggle between private and public visibility. +By upgrading to a team Workspace, you'll have unlimited Contributor and Repository Insights, as well as the ability to toggle between private and public visibility. :::info diff --git a/docs/maintainers/maintainers-guide.md b/docs/maintainers/maintainers-guide.md index b17a23a1..f04f2066 100644 --- a/docs/maintainers/maintainers-guide.md +++ b/docs/maintainers/maintainers-guide.md @@ -23,8 +23,8 @@ To get started, you will need to create an account on OpenSauced. You can do thi When you're working with a team, managing multiple projects or even an assortment of repositories within a single project can become overwhelming, especially as you try to keep everyone up-to-date on key information that impacts your projects. Understanding the direction and value of your project can be challenging. To navigate these challenges effectively, you can use Workspaces to: - **Understand your project at a high level**: Being able to look at all your repositories and understand them at a high level makes it easier for you to share this information, collaborate with others, and understand where your projects stand in terms of health. -- **Collaborate and create transparency with your team**: Understanding the activity for all of your projects equips you to make decisions as a team, set goals for your projects, and understand what brings the most value to those using your project. -- **Streamline contributor engagement**: Having a high level understanding of your project is a good step in understanding your project’s value, but really understanding what’s happening beneath the surface is the next step in being able to assess project health, growth, and the contributor community. +- **Collaborate and create transparency with your team**: Understanding the activity for all of your projects equips you to make decisions as a team, set goals for your projects, and understand what brings the most value to those using your project. +- **Streamline contributor engagement**: Having a high level understanding of your project is a good step in understanding your project’s value, but really understanding what’s happening beneath the surface is the next step in being able to assess project health, growth, and the contributor community. - **Measure and share success**: Without insight into your project's activity level, health, and contributor community, it can be a challenge to show the value of your projects. Having real-time analytics on your projects can help you to highlight your key achievements, recognize the impact of your contributors, and communicate the hard work that’s been put into your projects. Workspaces is a feature designed to provide maintainers and teams with a centralized platform for organizing, tracking, and analyzing their open source activity. Workspaces gives you a holistic view of project health, team collaboration, and contributor engagement. diff --git a/docs/opensauced-guides/job-seekers-guide/categorize-contributions.md b/docs/opensauced-guides/job-seekers-guide/categorize-contributions.md index 61d97d84..36e17879 100644 --- a/docs/opensauced-guides/job-seekers-guide/categorize-contributions.md +++ b/docs/opensauced-guides/job-seekers-guide/categorize-contributions.md @@ -181,7 +181,7 @@ The Highlights feature allows you to post about your recent open source contribu | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Personal Information** | | | Name | Jane Smith | -| Contact Information | jane.smith@email.com | +| Contact Information | [jane.smith@email.com](mailto:jane.smith@email.com) | | Professional Profile (LinkedIn/GitHub/OpenSauced profile) | [LinkedIn](https://www.linkedin.com/in/janesmith), [GitHub](https://github.com/janesmith), [OpenSauced](https://app.opensauced.pizza/BekahHW) | | **Career Goals** | | | Desired Job Role | Frontend Developer | diff --git a/docs/opensauced-guides/students-guide/students-guide.md b/docs/opensauced-guides/students-guide/students-guide.md index fbfc161f..7cd75a37 100644 --- a/docs/opensauced-guides/students-guide/students-guide.md +++ b/docs/opensauced-guides/students-guide/students-guide.md @@ -44,7 +44,7 @@ Your profile is a great resource for showcasing your contributions and sharing y ![your profile](../../../static/img/profile.png) -On your profile, you will see the "Highlights" tab, which you can learn more about [in this section](#highlights-connecting-and-recognizing-contributions). Other tabs you may find useful on your profile are: +On your profile, you will see the "Highlights" tab, which you can learn more about [in this section](#highlights-connecting-and-recognizing-contributions). Other tabs you may find useful on your profile are: - **Contributions**: This tab includes a graph showing the number of PRs you have opened, [the velocity of your PRs](../../welcome/glossary.md#pr-velocity), and the number of repositories you have contributed to in the last thirty days. Underneath the graph is a "Latest PRs" chart, which shows a list of current and recent PRs. This tab is helpful if you want to showcase a steady and consistent open source contribution experience. - **Recommendations**: This tab includes a list of open source projects that are chosen based on the programming languages you picked in the "Interests" section of your public profile. It is useful if you're looking for new projects to contribute to. @@ -57,11 +57,10 @@ To get the full benefit of your profile, share it on social media, include a lin ### Your Dev Card -Another fun way to share your open source contributions is through your [Dev Card](../../features/dev-card.md). Your Dev Card is a visual representation of your open source contributions. It includes your [OSCR](../../welcome/glossary.md#oscr), profile picture, name, bio, and the number of your latest contributions. +Another fun way to share your open source contributions is through your [Dev Card](../../features/dev-card.md). Your Dev Card is a visual representation of your open source contributions. It includes your [OSCR](../../welcome/glossary.md#oscr), profile picture, name, bio, and the number of your latest contributions. ![dev card](../../../static/img/DevCard.png) - ## Explore: Finding Your Next Open Source Project The "Explore" tab is a great place to start if you're looking for a new open source project to contribute to. Here, you can find a list of open source projects and filter them by language, top repos, recent, most active, and more. @@ -174,7 +173,6 @@ Within the repositories dashboard, you can view the following metrics, which are - **Issues**: This includes the total number of opened and closed issues for the repositories in your workspace and the velocity of issues being closed. - **Engagement**: This includes the total number of stars, forks, and activity ratio for the repositories in your workspace. - ### Why Create a Workspace? There are many reasons to create a workspace. Here are a few: @@ -189,7 +187,6 @@ There are many reasons to create a workspace. Here are a few: 5. **Community Engagement Tracking**: By adding repositories you're interested in, you can monitor and engage with the communities behind them. This allows you to understand the dynamics of open source collaboration, which is invaluable for both personal and professional networking. - ## Repository Insights: Connecting Your Repositories 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. diff --git a/docs/opensauced-packages/semantic-release.md b/docs/opensauced-packages/semantic-release.md index b84bf7e2..b21a855c 100644 --- a/docs/opensauced-packages/semantic-release.md +++ b/docs/opensauced-packages/semantic-release.md @@ -139,7 +139,7 @@ You can opt to use this package in your local tooling. Proceed as you would norm npm install --save-dev @open-sauced/semantic-release-conventional-config ``` -The shareable config can then be configured in the [ `semantic-release` configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration): +The shareable config can then be configured in the [`semantic-release` configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration): ```json { diff --git a/docs/tools/chrome-extension/highlights.md b/docs/tools/chrome-extension/highlights.md index 76a2f9fe..621dbc48 100644 --- a/docs/tools/chrome-extension/highlights.md +++ b/docs/tools/chrome-extension/highlights.md @@ -18,7 +18,7 @@ keywords: - "Highlighted Insights" --- -If you're in GitHub, you can use the OpenSauced Chrome Extension to post a [highlight](highlights.md) of your pull requests to the OpenSauced website. +If you're in GitHub, you can use the OpenSauced Chrome Extension to post a [highlight](highlights.md) of your pull requests to the OpenSauced website. You can access the post to highlight it from the popup window in the extension. When you click it, it will automatically, populate the PR title and you can provide the summary. diff --git a/docs/tools/pizza-cli/codeowners.md b/docs/tools/pizza-cli/codeowners.md index 12babe5f..998ecea4 100644 --- a/docs/tools/pizza-cli/codeowners.md +++ b/docs/tools/pizza-cli/codeowners.md @@ -29,6 +29,7 @@ pizza generate config /path/to/local/git/repo ``` **This command will:** + - Iterate through the git ref-log - Inspect email signatures for commits - In interactive mode, ask you to attribute those users with GitHub handles @@ -44,16 +45,19 @@ The resulting `.sauced.yaml` file can be used to attribute owners in a `CODEOWNE ### Configuration Generation Examples 1. Generate a config file in the current directory: + ```sh pizza generate config ./ ``` 2. Generate a config file interactively: + ```sh pizza generate config ./ -i ``` 3. Generate a config file from the current directory and place resulting `.sauced.yaml` in a specific output directory: + ```sh pizza generate config ./ -o /path/to/directory ``` @@ -163,6 +167,7 @@ Without fallback, the codeowners generation might create a CODEOWNERS file like /file/with/codeowner @jpmcb /file/without/codeowner @open-sauced/engineering ``` + This ensures that all files have an assigned owner, even if there were no commits in the specified time range for certain files. ## Codeowners Command @@ -178,13 +183,15 @@ If you're already in your repository's root directory, you can use: ```bash pizza generate codeowners . ``` + :::info - Ensure you have the necessary permissions to read the repository and write the CODEOWNERS file. - The command requires a `.sauced.yaml` file in the repository root for accurate attribution (as described in the previous section). - If you encounter any errors, double-check that you've provided the correct path to your repository. + ::: The codeowners command will analyze your repository's commit history and generate a CODEOWNERS file based on contributors' activity in the last 90 days. -It is useful to keep this file up-to-date with the most recent codeowners. To automate this process, you can use the `pizza-action`. To learn more about this GitHub action, go to the [pizza-action docs](pizza-action.md) or visit [the repository](https://github.com/open-sauced/pizza-action). \ No newline at end of file +It is useful to keep this file up-to-date with the most recent codeowners. To automate this process, you can use the `pizza-action`. To learn more about this GitHub action, go to the [pizza-action docs](pizza-action.md) or visit [the repository](https://github.com/open-sauced/pizza-action). diff --git a/docs/tools/pizza-cli/pizza-action.md b/docs/tools/pizza-cli/pizza-action.md index 0ee8afd7..5ce81282 100644 --- a/docs/tools/pizza-cli/pizza-action.md +++ b/docs/tools/pizza-cli/pizza-action.md @@ -52,4 +52,4 @@ For more information about the Pizza Action, visit the [open-sauced/pizza-action ### Troubleshooting -If you encounter the error "pull request create failed: GraphQL: GitHub Actions is not permitted to create or approve pull requests (createPullRequest)", go to your repository settings under the Actions section and check "Allow GitHub Actions to create and approve pull requests". \ No newline at end of file +If you encounter the error "pull request create failed: GraphQL: GitHub Actions is not permitted to create or approve pull requests (createPullRequest)", go to your repository settings under the Actions section and check "Allow GitHub Actions to create and approve pull requests". diff --git a/docs/tools/pizza-cli/pizza-cli.md b/docs/tools/pizza-cli/pizza-cli.md index 6f3bd564..fc49c4cc 100644 --- a/docs/tools/pizza-cli/pizza-cli.md +++ b/docs/tools/pizza-cli/pizza-cli.md @@ -62,9 +62,10 @@ The pizza CLI provides multiple installation methods to cater to the varied pref ```bash curl -fsSL https://raw.githubusercontent.com/open-sauced/pizza-cli/main/install.sh ``` + :::danger - Piping scripts directly from the web to your shell can be risky. Always ensure you trust the source. + Piping scripts directly from the web to your shell can be risky. Always ensure you trust the source. ::: @@ -75,6 +76,7 @@ The pizza CLI provides multiple installation methods to cater to the varied pref vim install.sh ./install.sh ``` + - **Manual build and install**: For those who like a hands-on approach. ```bash diff --git a/docs/welcome/faqs.md b/docs/welcome/faqs.md index 4931d805..b0e8fe89 100644 --- a/docs/welcome/faqs.md +++ b/docs/welcome/faqs.md @@ -17,7 +17,7 @@ We believe that [good first issues don't exist](https://opensauced.pizza/blog/go However, sites like [Good First Issues](https://goodfirstissues.com/) and [First Timers Only](https://www.firsttimersonly.com/) can lead you to projects and issues worth working on. You can also use the `good first issue` label in the project search engine you want to contribute to. Check out [this guide](https://www.freecodecamp.org/news/how-to-find-good-first-issues-on-github/) to learn more about finding a `good first issue` on GitHub. -#### Additional Resources: +#### Additional Resources - ["Who's looking for open source contributors?" series on Dev.to](https://dev.to/bekahhw/series/23323) - [Intro to Open Source Course with OpenSauced](https://opensauced.pizza/learn/) @@ -30,7 +30,7 @@ Create a [Repository Insights Page](https://app.opensauced.pizza/hub/insights) o On every OpenSauced user profile, in the contributions tab, we display the Pull Requests and Issues that the user has commented on. This is to give a more comprehensive view of the user's contributions to the open-source community. It also provides insight into the contributor's depth of knowledge, collaboration and communication skills, and provides an additional data point for understanding the user's open-source contributions. -### 4. I want to provide feedback on OpenSauced. +### 4. I want to provide feedback on OpenSauced We love feedback. Post your suggestion in our [feedback repository](https://github.com/orgs/open-sauced/discussions). diff --git a/docs/welcome/glossary.md b/docs/welcome/glossary.md index 63a78611..f821125d 100644 --- a/docs/welcome/glossary.md +++ b/docs/welcome/glossary.md @@ -37,13 +37,13 @@ A contributor who has not been active on a project in the last 30 days. Contributor Confidence is a metric that estimates the likelihood of users who star or fork a repository returning to make contributions within a specified time range. It is calculated by analyzing the contribution patterns of these users, considering both their activity in other repositories and their direct contributions to the repository in question. Forks are weighted more heavily than stars, and users who do return to contribute significantly influence the confidence score. This metric helps contributors gauge the activity level of a repository and assists maintainers in understanding user engagement, thereby providing insights into the overall health and vibrancy of the project. -## Contributor Insights +## Contributor Insights 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. ## Lottery Factor -The Lottery Factor is a metric that identifies how at risk a project is if a key contributor leaves. It is calculated by the percentage of pull request (PR) contributions made by the top contributors. If 50% of the PR contributions come from two or fewer contributors, the lottery factor is high. +The Lottery Factor is a metric that identifies how at risk a project is if a key contributor leaves. It is calculated by the percentage of pull request (PR) contributions made by the top contributors. If 50% of the PR contributions come from two or fewer contributors, the lottery factor is high. The name "Lottery Factor" comes from the idea that if a key contributor wins the lottery and leaves, the project is at risk. This is sometimes known as the [bus factor](https://en.wikipedia.org/wiki/Bus_factor). @@ -78,4 +78,4 @@ The Repository Insights feature is a one-stop solution for understanding the pul ## YOLO Coders -A “YOLO coder” is an individual owner, contributor, or maintainer who pushes changes directly to the default branch of a repository without creating a pull request or seeking any community feedback. This risky practice bypasses essential review and collaboration processes. \ No newline at end of file +A “YOLO coder” is an individual owner, contributor, or maintainer who pushes changes directly to the default branch of a repository without creating a pull request or seeking any community feedback. This risky practice bypasses essential review and collaboration processes. diff --git a/src/css/custom.css b/src/css/custom.css index 87349e1d..d792f1d4 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -15,7 +15,7 @@ --ifm-color-primary-lighter: #359962; --ifm-color-primary-lightest: #3cad6e; } -html[data-theme='dark'] { +html[data-theme="dark"] { --ifm-color-primary: #25c2a0; --ifm-color-primary-dark: #21af90; --ifm-color-primary-darker: #1fa588; @@ -32,7 +32,7 @@ html[data-theme='dark'] { padding: 0 var(--ifm-pre-padding); } -html[data-theme='dark'] .docusaurus-highlight-code-line { +html[data-theme="dark"] .docusaurus-highlight-code-line { background-color: rgba(0, 0, 0, 0.3); } @@ -41,7 +41,7 @@ html[data-theme='dark'] .docusaurus-highlight-code-line { } .footer__col > .footer__title::after { - content: ''; + content: ""; display: inline-block; width: 28px; height: 23px;