honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: several minor fixes/improvements to docs contributing guides (#41250) 

This commit includes several minor fixes and improvements to the
`updating-content-github-ui` and `updating-search-keywords` guides.

PR Close #41250
This commit is contained in:
George Kalpakas 2021-03-17 20:46:58 +02:00 committed by Alex Rickabaugh
parent f190c41e50
commit 8b9d98ec63
2 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
aio/content/guide/updating-content-github-ui.md
View File

@ -1,10 +1,10 @@
# Updating topics through the GitHub user interface
This topic describes how to submit pull requests to the Angular repository using GitHub's user interface. If you are unfamiliar with Git, you might find this process easier for making changes.
This topic describes how to submit pull requests to the Angular repository using GitHub's user interface. If you are unfamiliar with [Git](https://git-scm.com/), you might find this process easier for making changes.
<div class="alert is-warning">
Using the GitHub user interface for updates is recommended only for small changes, such as [updating the review date](guide/reviewing-content) or [updating search keywords](guide/updating-search-keywords).
Using the GitHub user interface for updates is recommended only for small changes to one file at a time, such as fixing typos, [updating the review date](guide/reviewing-content) or [updating search keywords](guide/updating-search-keywords).
</div>
@ -22,16 +22,16 @@ This topic describes how to submit pull requests to the Angular repository using
1. Update the topic.
1. At the bottom of the screen, update the Commit Changes box with a description of the change. Use the format `docs: <short-description-of-change>`, where `<short-description-of-change>` briefly describes your change. Keep the description under 100 characters. For example:
1. At the bottom of the screen, update the **Commit changes** box with a description of the change. Use the format `docs: <short-description-of-change>`, where `<short-description-of-change>` briefly describes your change. Keep the description under 100 characters. For example:
`docs: fix typo in Tour of Heroes pt.1`
1. Verify that the **create new branch** option is selected, then click **Commit Changes**.
1. Verify that the **create new branch** option is selected, then click **Commit changes**.
A Pull Request screen opens.
1. Fill out the form in the Pull Request screen. At a minimum, put an `x` in the **Docs have been added / updated** option and the **Documentation content changes** option.
1. Click **Create Pull Request**.
1. Click **Create pull request**.
At this point, your pull request is added to a list of current requests, which the documentation team reviews weekly.

22
aio/content/guide/updating-search-keywords.md
View File

@ -1,10 +1,10 @@
# Updating search keywords
In documentation, being able to find the content you need is equally as important as the content itself. In Angular.io, users can discover content in several ways, including:
In documentation, being able to find the content you need is equally as important as the content itself. In [angular.io](https://angular.io/), users can discover content in several ways, including:
* Organic search results, such as through google.com
* The table of contents, also known as the left navigation
* Using the search box on Angular.io
* Organic search results, such as through [google.com](https://google.com/)
* The left navigation bar, also known as sidenav
* Using the search box in the header
You can help improve the documentation experience by adding search keywords to a given topic. Updating search keywords can help bring users to the content they need faster.
@ -12,19 +12,23 @@ You can help improve the documentation experience by adding search keywords to a
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:**
## Updating search keywords
To update search keywords:
1. Navigate to the topic to which you want to update search keywords.
1. Decide what search keywords you'd like to add to the topic. For information on how to format keywords, see [Search keywords format](#format).
1. Update the {`@searchKeywords 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 `@searchKeywords` 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).
If a topic does not have a {`@searchKeywords`} tag, you can add it to the end of the topic.
If a topic does not have a `@searchKeywords` tag, you can add it to the end of the topic.
{@a format}
## Search keywords format
You add search keywords to a topic using the {`@searchKeywords`} tag. This tag takes a set of single words, separated by spaces. For example:
You add search keywords to a topic using the `@searchKeywords` tag. This tag takes a set of single words, separated by spaces. The tag and the keywords must be enclosed in curly brackets (`{...}`). For example:
{`@searchKeywords route router routing navigation`}
<code-example>
&#123;@searchKeywords route router routing navigation&#125;
</code-example>