diff --git a/assets/images/help/repository/add-autolink-reference-details.png b/assets/images/help/repository/add-autolink-reference-details.png index 171fdac456..54afefe12f 100644 Binary files a/assets/images/help/repository/add-autolink-reference-details.png and b/assets/images/help/repository/add-autolink-reference-details.png differ diff --git a/assets/images/help/repository/add-button-community-profile.png b/assets/images/help/repository/add-button-community-profile.png index b310035621..03349e4031 100644 Binary files a/assets/images/help/repository/add-button-community-profile.png and b/assets/images/help/repository/add-button-community-profile.png differ diff --git a/assets/images/help/repository/add-reference-prefix-field-alphanumeric.png b/assets/images/help/repository/add-reference-prefix-field-alphanumeric.png deleted file mode 100644 index 6e51a0bca2..0000000000 Binary files a/assets/images/help/repository/add-reference-prefix-field-alphanumeric.png and /dev/null differ diff --git a/assets/images/help/repository/add-reference-prefix-field.png b/assets/images/help/repository/add-reference-prefix-field.png deleted file mode 100644 index c994804116..0000000000 Binary files a/assets/images/help/repository/add-reference-prefix-field.png and /dev/null differ diff --git a/assets/images/help/repository/add-tag-protection-rule.png b/assets/images/help/repository/add-tag-protection-rule.png deleted file mode 100644 index 9e716d8cd5..0000000000 Binary files a/assets/images/help/repository/add-tag-protection-rule.png and /dev/null differ diff --git a/assets/images/help/repository/add-target-url-field-alphanumeric.png b/assets/images/help/repository/add-target-url-field-alphanumeric.png deleted file mode 100644 index 4525a59a97..0000000000 Binary files a/assets/images/help/repository/add-target-url-field-alphanumeric.png and /dev/null differ diff --git a/assets/images/help/repository/add-target-url-field.png b/assets/images/help/repository/add-target-url-field.png deleted file mode 100644 index 4a38aebb6f..0000000000 Binary files a/assets/images/help/repository/add-target-url-field.png and /dev/null differ diff --git a/assets/images/help/repository/add-template-drop-down-menu.png b/assets/images/help/repository/add-template-drop-down-menu.png index d446332cf7..6b480648df 100644 Binary files a/assets/images/help/repository/add-template-drop-down-menu.png and b/assets/images/help/repository/add-template-drop-down-menu.png differ diff --git a/assets/images/help/repository/add-topic-form.png b/assets/images/help/repository/add-topic-form.png index 109eff3c46..258d140a47 100644 Binary files a/assets/images/help/repository/add-topic-form.png and b/assets/images/help/repository/add-topic-form.png differ diff --git a/assets/images/help/repository/autolink-format-setting.png b/assets/images/help/repository/autolink-format-setting.png deleted file mode 100644 index f515777d43..0000000000 Binary files a/assets/images/help/repository/autolink-format-setting.png and /dev/null differ diff --git a/assets/images/help/repository/autolink-references-tab.png b/assets/images/help/repository/autolink-references-tab.png deleted file mode 100644 index 80546eee33..0000000000 Binary files a/assets/images/help/repository/autolink-references-tab.png and /dev/null differ diff --git a/assets/images/help/repository/edit-repository-details-gear.png b/assets/images/help/repository/edit-repository-details-gear.png index e58e8d5673..9c2c5f32ca 100644 Binary files a/assets/images/help/repository/edit-repository-details-gear.png and b/assets/images/help/repository/edit-repository-details-gear.png differ diff --git a/assets/images/help/repository/edit-repository-details-save-changes-button.png b/assets/images/help/repository/edit-repository-details-save-changes-button.png deleted file mode 100644 index 5dfff63f3c..0000000000 Binary files a/assets/images/help/repository/edit-repository-details-save-changes-button.png and /dev/null differ diff --git a/assets/images/help/repository/new-tag-protection-rule.png b/assets/images/help/repository/new-tag-protection-rule.png deleted file mode 100644 index 9f2adbe06c..0000000000 Binary files a/assets/images/help/repository/new-tag-protection-rule.png and /dev/null differ diff --git a/assets/images/help/repository/propose-button-community-profile.png b/assets/images/help/repository/propose-button-community-profile.png index aa2cfe684e..8cb3fd0d17 100644 Binary files a/assets/images/help/repository/propose-button-community-profile.png and b/assets/images/help/repository/propose-button-community-profile.png differ diff --git a/assets/images/help/repository/set-tag-protection-pattern.png b/assets/images/help/repository/set-tag-protection-pattern.png deleted file mode 100644 index 48bf3743e2..0000000000 Binary files a/assets/images/help/repository/set-tag-protection-pattern.png and /dev/null differ diff --git a/assets/images/help/repository/set-up-templates.png b/assets/images/help/repository/set-up-templates.png deleted file mode 100644 index 8008d40e84..0000000000 Binary files a/assets/images/help/repository/set-up-templates.png and /dev/null differ diff --git a/assets/images/help/repository/tag-protection-rule.png b/assets/images/help/repository/tag-protection-rule.png new file mode 100644 index 0000000000..7fdee2a277 Binary files /dev/null and b/assets/images/help/repository/tag-protection-rule.png differ diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md b/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md index dfea204479..a0c29b3f56 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories.md @@ -17,23 +17,23 @@ The community profile checklist checks to see if a project includes recommended ## Using the community profile checklist as a repository maintainer -As a repository maintainer, use the community profile checklist to see if your project meets the recommended community standards to help people use and contribute to your project. For more information, see "[Building community](https://opensource.guide/building-community/)" in the Open Source Guides. +As a repository maintainer, you can use the community standards checklist to see if your project meets the recommended community standards to help people use and contribute to your project. For more information, see "[Building community](https://opensource.guide/building-community/)" in the Open Source Guides. -If a project doesn't have a recommended file, you can click **Add** to draft and submit a file. +If a project doesn't have one of the recommended files, you can click the associated **Add** button to draft and submit a file. -{% data reusables.repositories.valid-community-issues %} For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." - -![Community profile checklist with recommended community standards for maintainers](/assets/images/help/repository/add-button-community-profile.png) +![Screenshot of the "Community Standards" maintainer checklist. Each item has an "Added" label (green checkmark) or a "Not added yet" label (orange circle).](/assets/images/help/repository/add-button-community-profile.png) {% data reusables.repositories.security-guidelines %} +{% data reusables.repositories.valid-community-issues %} For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." + ## Using the community profile checklist as a community member or collaborator As a potential contributor, use the community profile checklist to see if a project meets the recommended community standards and decide if you'd like to contribute. For more information, see "[How to contribute](https://opensource.guide/how-to-contribute/#anatomy-of-an-open-source-project)" in the Open Source Guides. If a project doesn't have a recommended file, you can click **Propose** to draft and submit a file to the repository maintainer for approval. -![Community profile checklist with recommended community standards for contributors](/assets/images/help/repository/propose-button-community-profile.png) +![Screenshot of the "Community Standards" contributor checklist. Each item has an "Added" label (green checkmark) or a "Not added yet" label (orange circle).](/assets/images/help/repository/propose-button-community-profile.png) ## Further reading diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/accessing-a-projects-community-profile.md b/content/communities/setting-up-your-project-for-healthy-contributions/accessing-a-projects-community-profile.md index d84bf3dd49..b362e90c7e 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/accessing-a-projects-community-profile.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/accessing-a-projects-community-profile.md @@ -15,8 +15,7 @@ shortTitle: Access community profiles {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} -3. In the left sidebar, click **Community**. -![Screenshot of the "Community" tab. The tab is highlighted with an orange outline.](/assets/images/help/graphs/graphs-sidebar-community-tab.png) +3. In the left sidebar, click **Community Standards** to show the checklist for the community profile of the repository. ## Further reading diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md index 8e3e89ff5f..a4f4835ed1 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md @@ -25,16 +25,15 @@ shortTitle: Configure {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -3. In the "Features" section, under "Issues," click **Set up templates**. -![Start template setup button](/assets/images/help/repository/set-up-templates.png) -4. Use the Add template drop-down menu, and click on the type of template you'd like to create. -![Add template drop-down menu](/assets/images/help/repository/add-template-drop-down-menu.png) +3. In the "Features" section, under "Issues," click **Set up templates**. You may need to enable "Issues" and refresh the page before you can see the button. +4. Use the Add template dropdown menu, and click on the type of template you'd like to create. + +![Screenshot of the "Add template" dropdown menu expanded to show the standard "Bug report" and "Feature request" templates. In addition, the "Custom template" is listed.](/assets/images/help/repository/add-template-drop-down-menu.png) 5. To preview or edit the template before committing it to the repository, click **Preview and edit**. ![Preview and edit button](/assets/images/help/repository/preview-and-edit-button.png) 6. To edit the template, click {% octicon "pencil" aria-label="The edit icon" %}, and type in the fields to edit their contents. ![Issue template edit button](/assets/images/help/repository/issue-template-edit-button.png) -7. To automatically set a default issue title, assign the issue to people with read access to the repository, or apply labels to your issue template, enter these details under "Optional additional information." You can also add these details in the issue template with `title`, `labels`, or `assignees` in a YAML frontmatter format. -![Additional info for issue template](/assets/images/help/repository/additional-issue-template-info.png) +7. To automatically set a default issue title, assign the issue to people with read access to the repository, or apply labels to issues raised from the template, use the fields under "Optional additional information." You can also add these details in the issue template with `title`, `labels`, or `assignees` in a YAML frontmatter format. 8. When you're finished editing and previewing your template, click **Propose changes** in the upper right corner of the page. ![Propose changes button](/assets/images/help/repository/propose-changes-button.png) 9. Enter a commit message describing your changes. diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md index c441f5bcc0..7cac8c3eb3 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics.md @@ -46,9 +46,13 @@ When creating a topic: {% endnote %} {% data reusables.repositories.navigate-to-repo %} -2. To the right of "About", click {% octicon "gear" aria-label="The Gear icon" %}. - ![Gear icon on main page of a repository](/assets/images/help/repository/edit-repository-details-gear.png) -3. Under "Topics", type the topic you want to add to your repository, then type a space. - ![Form to enter topics](/assets/images/help/repository/add-topic-form.png) -4. After you've finished adding topics, click **Save changes**. - !["Save changes" button in "Edit repository details"](/assets/images/help/repository/edit-repository-details-save-changes-button.png) +2. In the top right corner of the page, to the right of "About", click {% octicon "gear" aria-label="Edit repository metadata" %}. + + ![Screenshot of the top right of the main page for a repository. The "Edit repository metadata" button, shown as a gear icon, is outlined in orange.](/assets/images/help/repository/edit-repository-details-gear.png) + +3. Under "Topics", start to type the topic you want to add to your repository to display a dropdown menu of any matching topics. Click the topic you want to add or continue typing to create a new topic. + + ![Screenshot of the "Topics" field showing example topics: "docs" and "works-with-codespaces." A "Suggested" topic "documentation" is shown below.](/assets/images/help/repository/add-topic-form.png) + +4. Optional, if there are "Suggested" topics displayed under the "Topics" field, click {% octicon "plus" aria-label="Add this topic" %} to add or {% octicon "dash" aria-label="Decline this topic" %} to decline the suggested topic. +5. After you've finished adding topics, click **Save changes**. \ No newline at end of file diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md index 6018fec5c6..5ce3ddfd11 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources.md @@ -35,20 +35,21 @@ This procedure demonstrates how to configure autolinks to reference external res {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 %} -1. In the "Integrations" section of the sidebar, click **{% octicon "cross-reference" aria-label="The cross-reference icon" %} Autolink references**. +1. In the "Integrations" section of the sidebar, click **{% octicon "cross-reference" aria-label="" %} Autolink references**. {% else %} 1. In the left sidebar, click **Autolink references**. -![Autolink references tab in the left sidebar.](/assets/images/help/repository/autolink-references-tab.png) {% endif %} -1. Click **Add autolink reference**. -![Button to fill out autolink reference information.](/assets/images/help/repository/add-autolink-reference-details.png) +1. At the top right of the page, click **Add autolink reference**. + + ![Screenshot of the "autolink references" page. The "Add autolink reference" button is highlighted by a dark orange outline.](/assets/images/help/repository/add-autolink-reference-details.png) {% ifversion autolink-reference-alphanumeric %} -1. Select the format of the reference identifier used in the external resource, either alphanumeric or numeric. -![Autolink format setting, alphanumeric or numeric.](/assets/images/help/repository/autolink-format-setting.png) +1. Select the format of the reference identifier used in the external resource, either **Alphanumeric** or **Numeric**. {% endif %} -1. Under "Reference prefix", type a short, meaningful prefix you want collaborators to use to generate autolinks for the external resource. -{% ifversion autolink-reference-alphanumeric %}![Field to type abbreviation for external system.](/assets/images/help/repository/add-reference-prefix-field-alphanumeric.png){% else %}![Field to type abbreviation for external system.](/assets/images/help/repository/add-reference-prefix-field.png){% endif %} -1. Under "Target URL", type the link to the external system you want to link to. Use the `` variable as a placeholder for the reference identifier. -{% ifversion autolink-reference-alphanumeric %}![Field to type URL to external system.](/assets/images/help/repository/add-target-url-field-alphanumeric.png){% else %}![Field to type URL to external system.](/assets/images/help/repository/add-target-url-field.png){% endif %} -1. Click **Add autolink reference**. -{% ifversion autolink-reference-alphanumeric %}{% else %}![Button to add autolink reference.](/assets/images/help/repository/add-autolink-reference.png){% endif %} +1. Under "Reference prefix", type a short, meaningful prefix. Collaborators will use this text to generate autolinks for the external resource. +1. Under "Target URL", type the format of the link to the external system you want to create. Use the `` variable as a placeholder for the reference identifier. +1. Review the preview and verify that the autolink and external reference are both correct, then click **Add autolink reference** to define the link. + +For example, you might enter the following. +- Reference prefix: `JIRA-` +- Target URL: `https://jira.example.com/issue?query=` +- Preview: `JIRA-123` is converted to `https://jira.example.com/issue?query=123` \ No newline at end of file diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md index 20e96af5d9..244436eb72 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules.md @@ -25,8 +25,6 @@ Additionally, you can create custom repository roles to allow other groups of us {% data reusables.repositories.sidebar-settings %} 1. In the "Code and automation" section of the sidebar, click **{% octicon "tag" aria-label="The tag icon" %} Tags**. 1. Click **New rule**. -![New tag protection rule](/assets/images/help/repository/new-tag-protection-rule.png) 1. Under "Tag name pattern", type the pattern of the tags you want to protect. In this example, typing "\*" protects all tags. -![Set tag protection pattern](/assets/images/help/repository/set-tag-protection-pattern.png) +![Screenshot of the "Protected tags / New rule" page. The example pattern `*` is shown with the "Add rule" button. ](/assets/images/help/repository/tag-protection-rule.png) 1. Click **Add rule**. -![Add tag protection rule](/assets/images/help/repository/add-tag-protection-rule.png) diff --git a/data/reusables/repositories/click-collaborators-teams.md b/data/reusables/repositories/click-collaborators-teams.md index 300fea61ad..2d94570dfb 100644 --- a/data/reusables/repositories/click-collaborators-teams.md +++ b/data/reusables/repositories/click-collaborators-teams.md @@ -1 +1 @@ -1. In the "Access" section of the sidebar, click **{% octicon "people" aria-label="The people icon" %} Collaborators & teams**. +1. In the "Access" section of the sidebar, click **{% octicon "people" aria-label="" %} Collaborators & teams**. diff --git a/data/reusables/repositories/valid-community-issues.md b/data/reusables/repositories/valid-community-issues.md index 55eb88a76e..21ad8fe4c8 100644 --- a/data/reusables/repositories/valid-community-issues.md +++ b/data/reusables/repositories/valid-community-issues.md @@ -1 +1 @@ -To be included in the community profile checklist, issue templates must be located in the `.github/ISSUE_TEMPLATE` folder and contain valid `name:` and `about:` keys in the YAML frontmatter (for issue templates defined in `.md` files) or valid `name:` and `description:` keys (for issue forms defined in `.yml` files). +To be displayed with a {% octicon "check" aria-label="Added" %} checkmark in the community profile checklist, issue templates must be located in the `.github/ISSUE_TEMPLATE` folder and contain valid `name:` and `about:` keys in the YAML frontmatter (for issue templates defined in `.md` files) or valid `name:` and `description:` keys (for issue forms defined in `.yml` files).