diff --git a/assets/docs-team.gif b/assets/docs-team.gif deleted file mode 100644 index 32052ce..0000000 Binary files a/assets/docs-team.gif and /dev/null differ diff --git a/assets/gh-project-boards.gif b/assets/gif/gh-project-boards.gif similarity index 100% rename from assets/gh-project-boards.gif rename to assets/gif/gh-project-boards.gif diff --git a/assets/highlight.gif b/assets/gif/highlight.gif similarity index 100% rename from assets/highlight.gif rename to assets/gif/highlight.gif diff --git a/assets/issues-template.gif b/assets/gif/issues-template.gif similarity index 100% rename from assets/issues-template.gif rename to assets/gif/issues-template.gif diff --git a/assets/org-permissions.gif b/assets/gif/org-permissions.gif similarity index 100% rename from assets/org-permissions.gif rename to assets/gif/org-permissions.gif diff --git a/assets/saved-replies.gif b/assets/gif/saved-replies.gif similarity index 100% rename from assets/saved-replies.gif rename to assets/gif/saved-replies.gif diff --git a/assets/gif/team-sync-insights.gif b/assets/gif/team-sync-insights.gif new file mode 100644 index 0000000..61344f8 Binary files /dev/null and b/assets/gif/team-sync-insights.gif differ diff --git a/assets/gif/team-sync.gif b/assets/gif/team-sync.gif new file mode 100644 index 0000000..2e757fe Binary files /dev/null and b/assets/gif/team-sync.gif differ diff --git a/assets/img/contributors-insights.png b/assets/img/contributors-insights.png new file mode 100644 index 0000000..a97e101 Binary files /dev/null and b/assets/img/contributors-insights.png differ diff --git a/assets/failed-automated-tests.png b/assets/img/failed-automated-tests.png similarity index 100% rename from assets/failed-automated-tests.png rename to assets/img/failed-automated-tests.png diff --git a/assets/gh-actions.png b/assets/img/gh-actions.png similarity index 100% rename from assets/gh-actions.png rename to assets/img/gh-actions.png diff --git a/assets/org-permissions.png b/assets/img/org-permissions.png similarity index 100% rename from assets/org-permissions.png rename to assets/img/org-permissions.png diff --git a/assets/pr-template.png b/assets/img/pr-template.png similarity index 100% rename from assets/pr-template.png rename to assets/img/pr-template.png diff --git a/assets/list-from-insight.gif b/assets/list-from-insight.gif deleted file mode 100644 index f435c08..0000000 Binary files a/assets/list-from-insight.gif and /dev/null differ diff --git a/how-to-setup-your-project.md b/how-to-setup-your-project.md index 89e2245..af52dc6 100644 --- a/how-to-setup-your-project.md +++ b/how-to-setup-your-project.md @@ -136,7 +136,7 @@ You can create various issue templates, like bug reports, feature requests, docu There are two ways to create issue templates. The first way is to use GitHub's template builder. For this option, you will need to go to your project's settings, navigate to the "Features" section, and under "Issues", click on "Set up templates". Here is a [detailed guide](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-templates) from the GitHub documentation. -![Issue Template GIF](./assets/issues-template.gif) +![Issue template GIF](./assets/gif/issues-template.gif) ### Using YAML Files @@ -159,7 +159,7 @@ Here are a few things to consider inside your pull request template: Here is an example of a [good pull request template](https://raw.githubusercontent.com/open-sauced/.github/main/.github/PULL_REQUEST_TEMPLATE.md) used by OpenSauced. Please read through the [GitHub documentation](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository) to learn more about creating pull request templates. -![PR template example](./assets/pr-template.png) +![PR template example](./assets/img/pr-template.png) ## Projects (Classic) on GitHub @@ -171,4 +171,4 @@ To create a new project (classic) for an individual repository, navigate to your To learn more about projects (classic), please read through the [documentation](https://docs.github.com/en/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards). -![GitHub Project Board GIF](./assets/gh-project-boards.gif) +![GitHub Project Boards GIF](./assets/gif/gh-project-boards.gif) diff --git a/issues-and-pull-requests.md b/issues-and-pull-requests.md index 182d0b4..47bc7ad 100644 --- a/issues-and-pull-requests.md +++ b/issues-and-pull-requests.md @@ -100,7 +100,7 @@ If the author does not address the issue or respond to your initial comment, rep If multiple contributors are failing the same set of tests, then there is a possibility that the tests are flaky or broken and need your attention. In those situations, you want to clarify to the contributor that the failing test is not their fault and will be resolved. -![Failed automated tests img](./assets/failed-automated-tests.png) +![Failed automated tests](./assets/img/failed-automated-tests.png) ### Spam Pull Requests @@ -134,7 +134,7 @@ If you have repeatedly tried to reach out and get no response, you should close The [Highlights feature](https://docs.opensauced.pizza/features/highlights/) on OpenSauced is a place for you to showcase recent achievements with the open source community. This is a place to introduce your project to potential new contributors and talk about issues that need attention from the community. -![Highlights GIF](./assets/highlight.gif) +![Highlights GIF](./assets/gif/highlight.gif) ### Issue Highlights diff --git a/maintainer-powerups.md b/maintainer-powerups.md index a9aab80..a438240 100644 --- a/maintainer-powerups.md +++ b/maintainer-powerups.md @@ -10,7 +10,7 @@ Let's say your project receives more new issues and pull requests daily. You wan Setting up an action to automate these tasks will save you time in responding to contributions individually. You can decide which actions you want to have in each repository. -![Create GitHub Action GIF](./assets/gh-actions.png) +![Create GitHub Action](./assets/img/gh-actions.png) ### Types of Actions @@ -103,7 +103,7 @@ Sometimes, you repeatedly write the same reply to issues or pull requests. It's Read the GitHub documentation for complete instructions about how to [create saved replies](https://docs.github.com/en/get-started/writing-on-github/working-with-saved-replies/creating-a-saved-reply). -![saved replies GIF](./assets/saved-replies.gif) +![Saved replies gif](./assets/gif/saved-replies.gif) ## Code Owners diff --git a/your-team.md b/your-team.md index d6e4fd7..4a59eb8 100644 --- a/your-team.md +++ b/your-team.md @@ -66,7 +66,7 @@ To access your team's permissions, navigate to your team's page on GitHub and cl Here's what it will look like in GitHub: -![team permissions](/assets/org-permissions.png) +![team permissions](/assets/img/org-permissions.png) ### Additional Permissions to Consider @@ -87,7 +87,7 @@ Here's what it will look like in GitHub: You can see some of the options here: -![team permissions](/assets/org-permissions.gif) +![Team permissions GIF](/assets/gif/org-permissions.gif) ## Expanding the Horizons: Enlisting Additional Maintainers @@ -99,20 +99,22 @@ As your project grows in complexity, the need for specialized attention in speci It is certainly possible that there's no contributor with the right skills and passion to take on a specific role. In those cases, you might need to look outside your existing community. Reach out to other projects or communities that might have individuals with the necessary expertise. -One way to look for potential maintainers is to create an [Insight Page](https://docs.opensauced.pizza/features/insights/) with projects with a similar tech stack. This will allow you to see who is contributing to those projects on a regular basis, their most used languages, and more. From there, you can narrow down your search to individuals who are already familiar with your project's stack and have a proven track record of contributions by adding them to a [List](https://docs.opensauced.pizza/features/lists/). Lists will allow you to see more about where they're contributing, their timezone, their activity level, and more. +One way to look for potential maintainers is to create a [Repository Insight Page](https://docs.opensauced.pizza/features/repo-insights/) with projects with a similar tech stack. This will allow you to see who is contributing to those projects on a regular basis, their most used languages, and more. From there, you can narrow down your search to individuals who are already familiar with your project's stack and have a proven track record of contributions by adding them to a [Contributor Insight Page](https://docs.opensauced.pizza/features/contributor-insights/). Contributor Insights allows you to see more about where they're contributing, their timezone, their activity level, and more. -#### Creating an Insight Page & List +#### Creating a Repository and a Contributor Insight Page -To track 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 and track your 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 organization is a good idea if you want a unified view of your project activities and the list of contributors to your project. 2. **Add individual repositories**. Adding individual repositories is a good idea if you want to look at similar repositories to recruit team members. -From there, you can create a list of contributors you're interested in learning more about or connecting with by selecting them from the contributors tab and creating a new list. +![Sync team GIF](./assets/gif/team-sync-insights.gif) -![team insights gif](/assets/list-from-insight.gif) +From there, you can create a list of contributors you're interested in learning more about or connecting with by selecting them from the "Contributors" tab and creating a new Contributor Insight Page. + +![Contributor insights list](/assets/img/contributors-insights.png) ## Adding Team Members @@ -135,9 +137,9 @@ One way to onboard your new team members is by having clear guidelines and makin ## Keeping Track of Your Team -As your team grows, it's important to keep track of your team's participation and contributions. Depending on how many people are on your team,consider creating a [List](https://docs.opensauced.pizza/features/lists/) to keep track of your team's contributions. This will allow you to see who is contributing to your project and how often and to identify when it's time to remove someone from your team. +As your team grows, it's important to keep track of your team's participation and contributions. Depending on how many people are on your team, consider creating a [Contributor Insight Page](https://docs.opensauced.pizza/features/contributor-insights/) to keep track of your team's contributions. This will allow you to see who is contributing to your project and how often and to identify when it's time to remove someone from your team. -![docs team list](/assets/docs-team.gif) +![Team sync GIF](/assets/gif/team-sync.gif) ## Saying Farewell: Handling Team Departures