Skip to content

Commit

Permalink
docs: incorporating feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
David Shevitz committed Mar 8, 2021
1 parent dfd6e92 commit ba33961
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 22 deletions.
8 changes: 4 additions & 4 deletions aio/content/guide/contributors-guide-overview.md
Expand Up @@ -15,25 +15,25 @@ Before you get started with your contributions, we recommend that you review [Co
title="Reviewing content">
<section>Review content</section>
<p>Keep Angular content up-to-date by reviewing topics for accuracy.</p>
<p class="card-footer">Reviewing content</p>
<p class="card-footer">Help keep content up to date</p>
</a>
<a href="" class="docs-card"
title="Updating search keywords">
<section>Update search keywords</section>
<p>Help Angular developers by improving the search keywords for existing topics.</p>
<p class="card-footer">Updating search keywords</p>
<p class="card-footer">Improve documentation search</p>
</a>
<a href="" class="docs-card"
title="Updating content through GitHub">
<section>Update content through GitHub</section>
<p>Learn how to make documentation changes through the GitHub UI.</p>
<p class="card-footer">Updating content through GitHub</p>
<p class="card-footer">Contribute to Angular in your browser</p>
</a>
<a href="" class="docs-card"
title="Documentation Style Guide">
<section>Documentation style guide</section>
<p>Review the syntax and styles used within the Angular documentation set.</p>
<p class="card-footer">Documentation style guide</p>
<p class="card-footer">Get to know the writing style</p>
</a>
</div>

8 changes: 3 additions & 5 deletions aio/content/guide/reviewing-content.md
Expand Up @@ -6,14 +6,14 @@ 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 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#contributing-to-angular) guide available if you're filing your first pull request in the repository.

## Reviewing content (`@reviewed`)

All of the task-based guides, tutorials, and conceptual topics that you find on Angular.io support a `@reviewed` tag. When present, this tag is followed by the date representing when a given topic was reviewed for accuracy and completeness. On the published topic, this reviewed information appears at the bottom of the topic.
All of the task-based guides, tutorials, and conceptual topics that you find on Angular.io support a `@reviewed` tag. When present, this tag is followed by the date representing when a given topic was reviewed for accuracy and completeness. On the published topic, this reviewed information appears at the bottom of the topic; for example, `Last reviewed on` followed by the day of the week, month, day, and year.

<div class="lightbox">
<img src="generated/images/guide/contributors-guide/last-reviewed.png" alt="Example of the last reviewed date on a page footer.">
<img src="generated/images/guide/contributors-guide/last-reviewed.png" alt="Example of the last reviewed date specifying the day of the week, the month, the date, and the year on a page footer.">
</div>

This reviewed date indicates when someone last reviewed the topic to ensure that its contents were accurate.
Expand All @@ -38,5 +38,3 @@ You can review a topic using either the GitHub user interface or the command lin
### Review criteria

In general, topics should be reviewed either every six months, or around every major release.

On occasion, topics might require a more frequent review. However, we request that you do not file unnecessary pull requests for reviewing content.
4 changes: 3 additions & 1 deletion aio/content/guide/updating-content-github-ui.md
Expand Up @@ -22,7 +22,9 @@ 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 describs your change. Keep the description under 100 characters.
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 describs 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**.

Expand Down
18 changes: 7 additions & 11 deletions aio/content/guide/updating-search-keywords.md
Expand Up @@ -3,32 +3,28 @@
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:

* Organic search results, such as through google.com
* The table of contents (also known as the left navigation)
* The table of contents, also known as the left navigation
* Using the search box on Angular.io

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.

## 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 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#contributing-to-angular) guide available if you're filing your first pull request in the repository.

**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) for i
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-an-issue).
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-an-issue).

If a topic does not have a `{@searchKeywords}` tag, you can add it to end of the topic.
If a topic does not have a {`@searchKeywords`} tag, you can add it to 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. For example:

<code-example lanugage="javascript">

{@searchKeywords route router routing navigation}

</code-example>
{`@searchKeywords route router routing navigation`}
6 changes: 5 additions & 1 deletion aio/content/navigation.json
Expand Up @@ -963,10 +963,14 @@
]
},
{
"url": "guide/contributors-guide-overview",
"title": "Content Contributor's Guide",
"tooltip": "Describes how to contribute to the Angular documentation.",
"children": [
{
"url": "guide/contributors-guide-overview",
"title": "Overview",
"tooltip": "Provides an overview of how to contribute to Angular's documentation"
},
{
"url": "guide/reviewing-content",
"title": "Reviewing content",
Expand Down

0 comments on commit ba33961

Please sign in to comment.