From f190c41e50cc8b99f61b796042170f633b2a21de Mon Sep 17 00:00:00 2001 From: George Kalpakas Date: Wed, 17 Mar 2021 20:46:58 +0200 Subject: [PATCH] docs: use dedicated anchors for links to `CONTRIBUTING.md` (#41250) Previously, some links to specific sections of `CONTRIBUTING.md` were using hashes automatically generated by GitHub based on the section headings. This resulted in less readable hashes which were directly tied to the heading text and thus less robust (i.e. more likely to break if the heading was re-worded in the future). This commit switches such links to use the dedicated anchors, which are more succinct/readable and more stable. PR Close #41250 --- .github/ISSUE_TEMPLATE/1-bug-report.md | 2 +- aio/content/guide/contributors-guide-overview.md | 2 +- aio/content/guide/reviewing-content.md | 6 +++--- aio/content/guide/updating-search-keywords.md | 2 +- docs/SAVED_REPLIES.md | 4 ++-- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.md b/.github/ISSUE_TEMPLATE/1-bug-report.md index 4785c8fb39..8cf9b32bb1 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.md +++ b/.github/ISSUE_TEMPLATE/1-bug-report.md @@ -43,7 +43,7 @@ Share the link to the repo below along with step-by-step instructions to reprodu Issues that don't have enough info and can't be reproduced will be closed. -You can read more about issue submission guidelines here: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-submitting-an-issue +You can read more about issue submission guidelines here: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#submit-issue --> ## 🔥 Exception or Error diff --git a/aio/content/guide/contributors-guide-overview.md b/aio/content/guide/contributors-guide-overview.md index 7d1b30065d..fd2d321579 100644 --- a/aio/content/guide/contributors-guide-overview.md +++ b/aio/content/guide/contributors-guide-overview.md @@ -6,7 +6,7 @@ The topics in this section cover ways in which you can contribute to the Angular ## Before you begin -Before you get started with your contributions, we recommend that you review [Contributing to Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#contributing-to-angular). That topic explains many of the tasks and guidelines you need to know before you make your first pull request. +Before you get started with your contributions, we recommend that you review [Contributing to Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md). That topic explains many of the tasks and guidelines you need to know before you make your first pull request. ## Contributing to Angular diff --git a/aio/content/guide/reviewing-content.md b/aio/content/guide/reviewing-content.md index 60efd93527..7e5514a7e8 100644 --- a/aio/content/guide/reviewing-content.md +++ b/aio/content/guide/reviewing-content.md @@ -6,7 +6,7 @@ This topic describes how you can help keep Angular content up-to-date by reviewi ## Before you begin -You can review content even if you've never contributed to Angular before. However, you may find it helpful to have the [Contributing to Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#contributing-to-angular) guide available if you're filing your first pull request in the repository. +You can review content even if you've never contributed to Angular before. However, you may find it helpful to have the [Contributing to Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md) guide available if you're filing your first pull request in the repository. ## Reviewing content (`@reviewed`) @@ -31,9 +31,9 @@ You can review a topic using either the GitHub user interface or in an editor on 1. Read through the topic. -1. If the topic requires an update, either [file an issue](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-submitting-an-issue) that describes the update required, or [create a pull request](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-submitting-a-pull-request-pr) with the update. +1. If the topic requires an update, either [file an issue](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#submit-issue) that describes the update required, or [create a pull request](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#submit-pr) with the update. -1. Update the `@reviewed` tag, either through the [GitHub user interface](guide/updating-content-github-ui) or through Angular's [standard pull request process](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-submitting-a-pull-request-pr). +1. Update the `@reviewed` tag, either through the [GitHub user interface](guide/updating-content-github-ui) or through Angular's [standard pull request process](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#submit-pr). {@a review-criteria} ### Review criteria diff --git a/aio/content/guide/updating-search-keywords.md b/aio/content/guide/updating-search-keywords.md index 2c286828f6..e837de5a63 100644 --- a/aio/content/guide/updating-search-keywords.md +++ b/aio/content/guide/updating-search-keywords.md @@ -10,7 +10,7 @@ You can help improve the documentation experience by adding search keywords to a ## Before you begin -You can update search keywords for a topic even if you've never contributed to Angular before. However, you may find it helpful to have the [Contributing to Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#contributing-to-angular) guide available if you're filing your first pull request in the repository. +You can update search keywords for a topic even if you've never contributed to Angular before. However, you may find it helpful to have the [Contributing to Angular](https://github.com/angular/angular/blob/master/CONTRIBUTING.md) guide available if you're filing your first pull request in the repository. **To update search keywords:** diff --git a/docs/SAVED_REPLIES.md b/docs/SAVED_REPLIES.md index 4e8e1d0839..6d801b945f 100644 --- a/docs/SAVED_REPLIES.md +++ b/docs/SAVED_REPLIES.md @@ -34,7 +34,7 @@ Thanks for reporting this issue. However this issue is a duplicate of an existin ## Angular: Insufficient Information Provided (v2) ``` -Thanks for reporting this issue. However, you didn't provide sufficient information for us to understand and reproduce the problem. Please check out [our submission guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-submitting-an-issue) to understand why we can't act on issues that are lacking important information. +Thanks for reporting this issue. However, you didn't provide sufficient information for us to understand and reproduce the problem. Please check out [our submission guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#submit-issue) to understand why we can't act on issues that are lacking important information. If the problem still exists in your application, please [open a new issue](https://github.com/angular/angular/issues/new/choose) and follow the instructions in the issue template. @@ -69,5 +69,5 @@ If the problem still exists in your application, please [open a new issue](https ``` Hello, we reviewed this issue and determined that it doesn't fall into the bug report or feature request category. This issue tracker is not suitable for support requests, please repost your issue on [StackOverflow](https://stackoverflow.com/) using tag `angular`. -If you are wondering why we don't resolve support issues via the issue tracker, please [check out this explanation](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-got-a-question-or-problem). +If you are wondering why we don't resolve support issues via the issue tracker, please [check out this explanation](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#question). ```