Skip to content

Commit

Permalink
docs: set titles to sentence case (#47083)
Browse files Browse the repository at this point in the history
* update overview and reviewing topics to accommodate new ToC
* incorporate edits from peer reviews

PR Close #47083
  • Loading branch information
Bob Watson authored and pkozlowski-opensource committed Aug 12, 2022
1 parent 5547ce0 commit bb465e1
Show file tree
Hide file tree
Showing 4 changed files with 305 additions and 198 deletions.
107 changes: 101 additions & 6 deletions aio/content/guide/contributors-guide-overview.md
@@ -1,14 +1,85 @@
# Documentation contributor's guide
# Documentation contributor guide

Angular, as an open source project, depends on its community. This dependence is particularly important to the documentation. The more the community contributes to the documentation, the better the documentation becomes, which helps both new and experienced Angular developers.
The topics in this section describe how you can contribute to this documentation.
For information about contributing only code to the Angular framework, see [Contributing to Angular][GithubAngularAngularBlobMainContributingMd].

The topics in this section cover ways in which you can contribute to the Angular documentation set.
Angular, an open source project, depends on its community, especially when it comes to the documentation.
The more the community contributes to the documentation, the better the documentation becomes.
Input from you helps both new and experienced Angular developers.

## Before you begin
<div class="alert is-important">

Before you get started with your contributions, review [Contributing to Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md). That topic explains many of the tasks and guidelines you need to know before you make your first pull request.
You must have a GitHub account to propose a minor change or review and edit the documentation.

## Contributing to Angular documentation
</div>

## Propose a minor change

You can propose minor changes to a documentation topic without downloading any software. Choose the pencil icon&nbsp;<img alt="drawing of a pencil used as the topic edit icon" src="generated/images/guide/contributors-guide/edit-icon.png" > at the top of the page, to the right of the topic title to enter your suggestion.

## Review and edit documentation topics

This section describes how to make larger contributions to the documentation.

### Before you start

The following steps set up your local computer to contribute documentation content.

1. Sign into your account on GitHub.
If you don't have an account on GitHub, [create a new account][GithubJoin] before you continue.
2. In your browser, navigate to [https://github.com/angular/angular][GithubAngular].
3. In your browser, fork the `angular/angular` repo into your GitHub account.
1. From [https://github.com/angular/angular][GithubAngular] in the browser, choose the **Fork** button near the top-right corner of the page.
2. If asked, choose to create a fork to contribute to the original project.
4. On the computer that you want to edit, clone your fork of the `angular` repo.
5. In the `angular/aio` directory of your cloned repo, locally build and view the documentation.
1. Run the following commands.
To learn more, see [Angular documentation project][GithubAngularAngularBlobMainAioReadmeMd].

<code-example format="shell" language="shell">

yarn

</code-example>

<code-example format="shell" language="shell">

yarn setup

</code-example>

<code-example format="shell" language="shell">

yarn build

</code-example>

<code-example format="shell" language="shell">

yarn start

</code-example>

<div class="callout is-helpful">

**NOTE**: <br/>
If you have any errors or issues with your yarn install, just re-run the `yarn` command.

</div>

2. In your browser, navigate to [http://localhost:4200][AngularLocalhost]
3. Review your local build of the Angular framework documentation.

After you can see your local build of the Angular framework documentation on your own system, you are ready to review and edit it. The following sections help you with the next steps.

### Before you edit the documentation

The following steps prepare you to edit the Angular documentation successfully:

1. Review [Contributing to Angular][GithubAngularAngularBlobMainContributingMd].
2. Install [the documentation linter][GithubAngularAngularTreeMainAioToolsDocLinterInstallValeOnYourDevelopmentSystemReadmeMd].

### Ways to contribute to Angular documentation

<div class="card-container">
<a href="guide/reviewing-content" class="docs-card" title="Reviewing content">
Expand All @@ -26,6 +97,11 @@ Before you get started with your contributions, review [Contributing to Angular]
<p>Learn how to make documentation changes through the GitHub UI.</p>
<p class="card-footer">Contribute to Angular in your browser</p>
</a>
</div>

### More resources for contributing to documentation

<div class="card-container">
<a href="guide/docs-style-guide" 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>
Expand All @@ -38,3 +114,22 @@ Before you get started with your contributions, review [Contributing to Angular]
</a>
</div>

<!-- links -->

<!-- external links -->

[GithubJoin]: https://github.com/join "Join GitHub | GitHub"

[GithubAngular]: https://github.com/angular/angular "angular/angular | GitHub"

[GithubAngularAngularBlobMainAioReadmeMd]: https://github.com/angular/angular/blob/main/aio/README.md "Angular documentation project (https://angular.io) | angular/angular | Github"

[GithubAngularAngularBlobMainContributingMd]: https://github.com/angular/angular/blob/main/CONTRIBUTING.md "Contributing to Angular | angular/angular | Github"

[GithubAngularAngularTreeMainAioToolsDocLinterInstallValeOnYourDevelopmentSystemReadmeMd]: https://github.com/angular/angular/tree/main/aio/tools/doc-linter/README.md#install-vale-on-your-development-system "Install Vale on your development system - Angular documentation lint tool | angular/angular | Github"

[AngularLocalhost]: http://localhost:4200 "Angular.io on localhost"

<!--end links -->

@reviewed 2022-08-08
72 changes: 42 additions & 30 deletions aio/content/guide/reviewing-content.md
@@ -1,57 +1,69 @@
# Reviewing Content
# Reviewing documentation

You can review the Angular documentation, even if you never contributed to Angular before.

Angular developers work best when they have access to accurate and complete documentation.
Keeping existing content up-to-date is an essential part of ensuring that all developers have a great documentation experience.
Keeping existing documentation up-to-date is an essential part of ensuring that all developers have a great development experience.

This topic describes how you can help keep Angular content up-to-date by reviewing content.
This topic describes how you can help keep the Angular documentation up-to-date by reviewing and updating it.

## 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/main/CONTRIBUTING.md) guide available if you're filing your first pull request in the repository.
Review the [Documentation contributor guide][AioDocContributorGuide] to get ready to review to update the documentation.
The *Documentation contributor guide* describes how to prepare to update a documentation topic.

You can edit a topic in the GitHub web interface or in your favorite code editor or integrated development environment (IDE).
In either case, you want to edit in your own fork of the Angular source code repo.

To review a documentation topic, you want to be able to edit the topic.
Even if you don't find any problem, you want to update the `@reviewed` tag at the end of the topic before you finish.

## Finding topics to review

## Reviewing content (`@reviewed`)
Find topic a topic that has not been reviewed in the past six months.

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.
At the bottom of some topics, there's an `@reviewed` tag that shows the date it was last reviewed.
This is an example of such a tag taken from the bottom of a topic.

<div class="lightbox">

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

</div>

This reviewed date indicates when someone last reviewed the topic to ensure that its contents were accurate.
## Reviewing and updating a topic

You can review a topic using either the GitHub user interface or in an editor on your local machine.
You can also review any topic that you like.
Previous experience in the subject of the topic is helpful, but not required.
To review a topic, use either the GitHub user interface or directly edit the source markdown file of the topic on your own computer.

**To review a topic:**
Feel free to review any topic in which you have interest.
Experience with the subject matter is helpful, but not required to provide copy edits.

1. Navigate to the topic that you want to review.
1. Locate the last reviewed date at the bottom of the topic and verify that the topic meets the [review criteria](#review-criteria).
**To review and update a documentation topic:**

If the topic does not have a last reviewed date, you are welcome to add it to the topic.
To add a date, use the `YYYY-MM-DD` date format.
Example:
`@reviewed 2021-03-23`
1. In your web browser, navigate to the topic that you want to review.
2. Locate the last reviewed date at the bottom of the topic. Verify that the topic has not been reviewed within the past six months.
3. Read through the topic.
4. If the topic requires an update, you can:
* [File an issue][GithubAngularAngularBlobMainContributingMdSubmitIssue] that describes the update required.
* Fix the issue and [create a pull request][GithubAngularAngularBlobMainContributingMdSubmitPr] with the update.
5. If the topic is accurate and doesn't need any revision, update, or add the `@reviewed` tag followed by the date you reviewed the topic. You can do this:
* By using the [GitHub user interface][AioGuideUpdatingContentGithubUi]
* By editing the file on your computer and creating a [standard pull request process][GithubAngularAngularBlobMainContributingMdSubmitPr] for Angular.

1. Read through the topic.
1. If the topic requires an update, either [file an issue](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#submit-issue) that describes the update required, or [create a pull request](https://github.com/angular/angular/blob/main/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/main/CONTRIBUTING.md#submit-pr).

<a id="review-criteria"></a>
<!-- links -->

### Review criteria
[AioDocContributorGuide]: guide/contributors-guide-overview "Documentation contributors guide | Angular"

In general, topics should be reviewed either every six months, or around every major release.
[AioGuideReviewingContentReviewCriteria]: guide/reviewing-content#review-criteria "Review criteria - Reviewing content | Angular"

<!-- links -->
[AioGuideUpdatingContentGithubUi]: guide/updating-content-github-ui "Updating topics through the GitHub user interface | Angular"

<!-- external links -->

[GithubAngularAngularBlobMainContributingMd]: https://github.com/angular/angular/blob/main/CONTRIBUTING.md "Contributing to Angular | angular/angular | Github"
[GithubAngularAngularBlobMainContributingMdSubmitIssue]: https://github.com/angular/angular/blob/main/CONTRIBUTING.md#submit-issue "Submitting an Issue - Contributing to Angular | angular/angular | GitHub"
[GithubAngularAngularBlobMainContributingMdSubmitPr]: https://github.com/angular/angular/blob/main/CONTRIBUTING.md#submit-pr "Submitting a Pull Request (PR) - Contributing to Angular | angular/angular | GitHub"

<!-- end links -->

@reviewed 2022-02-28
@reviewed 2022-08-08
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bb465e1

Please sign in to comment.