From bb465e17897a0ee7424cd5ef5c0e3a5c03eba1ac Mon Sep 17 00:00:00 2001 From: Bob Watson Date: Mon, 8 Aug 2022 11:05:32 -0700 Subject: [PATCH] docs: set titles to sentence case (#47083) * update overview and reviewing topics to accommodate new ToC * incorporate edits from peer reviews PR Close #47083 --- .../guide/contributors-guide-overview.md | 107 +++++- aio/content/guide/reviewing-content.md | 72 ++-- .../contributors-guide/topic-edit-icon.png | Bin 0 -> 361 bytes aio/content/navigation.json | 324 +++++++++--------- 4 files changed, 305 insertions(+), 198 deletions(-) create mode 100644 aio/content/images/guide/contributors-guide/topic-edit-icon.png diff --git a/aio/content/guide/contributors-guide-overview.md b/aio/content/guide/contributors-guide-overview.md index 620c612778d33..49b7db5f70a71 100644 --- a/aio/content/guide/contributors-guide-overview.md +++ b/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 +
-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 +
+ +## Propose a minor change + +You can propose minor changes to a documentation topic without downloading any software. Choose the pencil icon drawing of a pencil used as the topic edit icon 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]. + + + + yarn + + + + + + yarn setup + + + + + + yarn build + + + + + + yarn start + + + +
+ + **NOTE**:
+ If you have any errors or issues with your yarn install, just re-run the `yarn` command. + +
+ + 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
@@ -26,6 +97,11 @@ Before you get started with your contributions, review [Contributing to Angular]

Learn how to make documentation changes through the GitHub UI.

Contribute to Angular in your browser

 +
+ +### More resources for contributing to documentation + +
Documentation style guide

Review the syntax and styles used within the Angular documentation set.

@@ -38,3 +114,22 @@ Before you get started with your contributions, review [Contributing to Angular]
+ + + + +[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" + + + +@reviewed 2022-08-08 diff --git a/aio/content/guide/reviewing-content.md b/aio/content/guide/reviewing-content.md index 5ba30c875b8bb..3ef851fdd2a50 100644 --- a/aio/content/guide/reviewing-content.md +++ b/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.
-Example of the last reviewed date specifying the day of the week, the month, the date, and the year on a page footer. +Example of the last reviewed date entry showing the date the topic was reviewed as month, day, and year
-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). - - + -### 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" - +[AioGuideUpdatingContentGithubUi]: guide/updating-content-github-ui "Updating topics through the GitHub user interface | Angular" +[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" + -@reviewed 2022-02-28 +@reviewed 2022-08-08 diff --git a/aio/content/images/guide/contributors-guide/topic-edit-icon.png b/aio/content/images/guide/contributors-guide/topic-edit-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..984442fa5b0cfed0eaf3c099ba4a1c7982a95269 GIT binary patch literal 361 zcmV-v0ha!WP)uBdj0XAp-4=P~5m?@4S_)HNV!Ra@L~kxlCmZ z(8Vg>kc#tbP{_ON7MUwK(|#K&jQCOdsdn00000NkvXX Hu0mjf*sPv) literal 0 HcmV?d00001 diff --git a/aio/content/navigation.json b/aio/content/navigation.json index 2078f138690a5..176491533bb56 100644 --- a/aio/content/navigation.json +++ b/aio/content/navigation.json @@ -52,7 +52,7 @@ "hidden": false }, { - "title": "Getting Started", + "title": "Getting started", "tooltip": "Set up your environment and learn basic concepts", "children": [ { @@ -76,12 +76,12 @@ }, { "url": "start/start-data", - "title": "Managing Data", + "title": "Managing data", "tooltip": "Use services and access external data via HTTP." }, { "url": "start/start-forms", - "title": "Using Forms for User Input", + "title": "Using forms for user input", "tooltip": "Learn about fetching and managing data from users with forms." }, { @@ -118,22 +118,22 @@ }, { "url": "guide/lifecycle-hooks", - "title": "Component Lifecycle", + "title": "Component lifecycle", "tooltip": "Angular calls lifecycle hook methods on directives and components as it creates, changes, and destroys them." }, { "url": "guide/view-encapsulation", - "title": "View Encapsulation", + "title": "View encapsulation", "tooltip": "Describes how component CSS styles are encapsulated into a component's view." }, { "url": "guide/component-interaction", - "title": "Component Interaction", + "title": "Component interaction", "tooltip": "Share information between different directives and components." }, { "url": "guide/component-styles", - "title": "Component Styles", + "title": "Component styles", "tooltip": "Add CSS styles that are specific to a component." }, { @@ -143,17 +143,17 @@ }, { "url": "guide/content-projection", - "title": "Content Projection", + "title": "Content projection", "tooltip": "Learn how to create reusable components using Angular's content projection feature." }, { "url": "guide/dynamic-component-loader", - "title": "Dynamic Components", + "title": "Dynamic components", "tooltip": "Load components dynamically." }, { "url": "guide/elements", - "title": "Angular Elements", + "title": "Angular elements", "tooltip": "Convert components to Custom Elements." } ] @@ -262,28 +262,28 @@ }, { "url": "guide/attribute-directives", - "title": "Attribute Directives", + "title": "Attribute directives", "tooltip": "Attribute directives attach behavior to elements." }, { "url": "guide/structural-directives", - "title": "Structural Directives", + "title": "Structural directives", "tooltip": "Structural directives manipulate the layout of the page." } ] }, { - "title": "Dependency Injection", - "tooltip": "Dependency Injection: creating and injecting services", + "title": "Dependency injection", + "tooltip": "Dependency injection: creating and injecting services", "children": [ { "url": "guide/dependency-injection-overview", "title": "Dependency injection in Angular", "tooltip": "Dependency injection is a design pattern in which a class requests dependencies from external sources." - }, + }, { "url": "guide/dependency-injection", - "title": "Understanding Dependency Injection", + "title": "Understanding dependency injection", "tooltip": "Angular's dependency injection system creates and delivers dependent services to Angular-created classes." }, { @@ -293,7 +293,7 @@ }, { "url": "guide/dependency-injection-providers", - "title": "Defining Dependency providers", + "title": "Defining dependency providers", "tooltip": "A provider factory function is a plain function that Angular can call to create a dependency." }, { @@ -325,23 +325,23 @@ }, { "url": "guide/change-detection-zone-pollution", - "title": "Zone Pollution", + "title": "Zone pollution", "tooltip": "Explains how Zone.js works and what are the common pitfalls that can slow an application down" }, { "url": "guide/change-detection-slow-computations", - "title": "Slow Computations", + "title": "Slow computations", "tooltip": "Learn how to make your application faster by discovering and optimizing slow calculations" }, { "url": "guide/change-detection-skipping-subtrees", - "title": "Skipping Component Subtrees", + "title": "Skipping component subtrees", "tooltip": "Learn how to skip change detection in component subtrees using OnPush change detection strategy" } ] }, { - "title": "Routing and Navigation", + "title": "Routing and navigation", "tooltip": "Learn how to use Angular Router to build in-app navigation between views.", "children": [ { @@ -356,17 +356,17 @@ }, { "url": "guide/router-tutorial", - "title": "Tutorial: Routing in Single-page Applications", + "title": "Tutorial: routing in single-page applications", "tooltip": "A tutorial that covers many patterns associated with Angular routing." }, { "url": "guide/routing-with-urlmatcher", - "title": "Tutorial: Creating custom route matches", + "title": "Tutorial: creating custom route matches", "tooltip": "Learn how to create a custom URL matcher with the Angular router." }, { "url": "guide/router-tutorial-toh", - "title": "Tutorial: Adding routing to Tour of Heroes", + "title": "Tutorial: adding routing to Tour of Heroes", "tooltip": "Explore how to use Angular's router. Based on the Tour of Heroes example." }, { @@ -387,12 +387,12 @@ }, { "url": "guide/reactive-forms", - "title": "Reactive Forms", + "title": "Reactive forms", "tooltip": "Create a reactive form using FormBuilder, groups, and arrays." }, { "url": "guide/typed-forms", - "title": "Strictly Typed Reactive Forms In Depth", + "title": "Strictly typed reactive forms in depth", "tooltip": "A deep-dive into the reactive forms types." }, { @@ -402,14 +402,14 @@ }, { "url": "guide/dynamic-form", - "title": "Building Dynamic Forms", + "title": "Building dynamic forms", "tooltip": "Create dynamic form templates using FormGroup." } ] }, { "url": "guide/http", - "title": "HTTP Client", + "title": "HTTP client", "tooltip": "Use HTTP to talk to a remote server." }, { @@ -418,47 +418,47 @@ "children": [ { "url": "guide/testing", - "title": "Intro to Testing", + "title": "Intro to testing", "tooltip": "Introduction to testing an Angular app." }, { "url": "guide/testing-code-coverage", - "title": "Code Coverage", + "title": "Code coverage", "tooltip": "Determine how much of your code is tested." }, { "url": "guide/testing-services", - "title": "Testing Services", + "title": "Testing services", "tooltip": "How to test services." }, { "url": "guide/testing-components-basics", - "title": "Basics of Testing Components", + "title": "Basics of testing components", "tooltip": "The fundamentals of how to test components." }, { "url": "guide/testing-components-scenarios", - "title": "Component Testing Scenarios", + "title": "Component testing scenarios", "tooltip": "Use cases for testing components." }, { "url": "guide/testing-attribute-directives", - "title": "Testing Attribute Directives", + "title": "Testing attribute directives", "tooltip": "How to test attribute directives." }, { "url": "guide/testing-pipes", - "title": "Testing Pipes", + "title": "Testing pipes", "tooltip": "Writing tests for pipes." }, { "url": "guide/test-debugging", - "title": "Debugging Tests", + "title": "Debugging tests", "tooltip": "How to debug tests." }, { "url": "guide/testing-utility-apis", - "title": "Testing Utility APIs", + "title": "Testing utility APIs", "tooltip": "Features of the Angular testing utilities." } ] @@ -577,7 +577,7 @@ }, { "url": "guide/route-animations", - "title": "Route Transition Animations", + "title": "Route transition animations", "tooltip": "Animate route transitions." } ] @@ -593,44 +593,44 @@ }, { "url": "guide/service-worker-getting-started", - "title": "Getting Started", + "title": "Getting started", "tooltip": "Enabling the service worker in a CLI project and observing behavior in the browser." }, { "url": "guide/app-shell", - "title": "App Shell", + "title": "App shell", "tooltip": "Render a portion of your app quickly to improve the startup experience." }, { "url": "guide/service-worker-communications", - "title": "Service Worker Communication", + "title": "Service worker communication", "tooltip": "Services that enable you to interact with an Angular service worker." }, { "url": "guide/service-worker-notifications", - "title": "Service Worker Notifications", + "title": "Service worker notifications", "tooltip": "Configuring service worker notification behavior." }, { "url": "guide/service-worker-devops", - "title": "Service Worker in Production", + "title": "Service worker in production", "tooltip": "Running apps with service workers, managing app update, debugging, and killing apps." }, { "url": "guide/service-worker-config", - "title": "Service Worker Configuration", + "title": "Service worker configuration", "tooltip": "Configuring service worker caching behavior." } ] }, { "url": "guide/web-worker", - "title": "Web Workers", + "title": "Web workers", "tooltip": "Using web workers for background processing." }, { "url": "guide/universal", - "title": "Server-side Rendering", + "title": "Server-side rendering", "tooltip": "Render HTML server-side with Angular Universal." }, { @@ -641,7 +641,7 @@ ] }, { - "title": "Best Practices", + "title": "Best practices", "tooltip": "Learn how to build robust, scalable applications.", "children": [ { @@ -656,32 +656,32 @@ }, { "url": "guide/updating", - "title": "Keeping Up-to-Date", + "title": "Keeping up-to-date", "tooltip": "Information about updating Angular applications and libraries to the latest version." }, { "url": "guide/property-binding-best-practices", - "title": "Property Binding Best Practices", + "title": "Property binding best practices", "tooltip": "Use property binding efficiently." }, { "url": "guide/lazy-loading-ngmodules", - "title": "Lazy Loading Feature Modules", + "title": "Lazy loading feature modules", "tooltip": "Lazy load modules to speed up your apps." }, { "url": "guide/lightweight-injection-tokens", - "title": "Lightweight Injection Tokens for Libraries", + "title": "Lightweight injection tokens for libraries", "tooltip": "Optimize client app size by designing library services with lightweight injection tokens." } ] }, { - "title": "Angular Tools", + "title": "Angular tools", "tooltip": "Tools to help you build your Angular applications.", "children": [ { - "title": "Dev Workflow", + "title": "Development workflow", "tooltip": "Build, and deployment information.", "children": [ { @@ -690,46 +690,46 @@ "tooltip": "Learn how to deploy your Angular app." }, { - "title": "AOT Compiler", + "title": "AOT compiler", "tooltip": "Understanding ahead-of-time compilation.", "children": [ { "url": "guide/aot-compiler", - "title": "Ahead-of-Time Compilation", + "title": "Ahead-of-Time compilation", "tooltip": "Learn why and how to use the Ahead-of-Time (AOT) compiler." }, { "url": "guide/angular-compiler-options", - "title": "Angular Compiler Options", + "title": "Angular compiler options", "tooltip": "Configuring AOT compilation." }, { "url": "guide/aot-metadata-errors", - "title": "AOT Metadata Errors", + "title": "AOT metadata errors", "tooltip": "Troubleshooting AOT compilation." }, { "url": "guide/template-typecheck", - "title": "Template Type-checking", + "title": "Template type-checking", "tooltip": "Template type-checking in Angular." } ] }, { "url": "guide/build", - "title": "Building & Serving", + "title": "Building & serving", "tooltip": "Building and serving Angular apps." } ] }, { "url": "guide/cli-builder", - "title": "CLI Builders", + "title": "CLI builders", "tooltip": "Using builders to customize Angular CLI." }, { "url": "guide/language-service", - "title": "Language Service", + "title": "Language service", "tooltip": "Use Angular Language Service to speed up dev time." }, { @@ -748,12 +748,12 @@ }, { "url": "guide/schematics-authoring", - "title": "Authoring Schematics", + "title": "Authoring schematics", "tooltip": "Understand the structure of a schematic." }, { "url": "guide/schematics-for-libraries", - "title": "Schematics for Libraries", + "title": "Schematics for libraries", "tooltip": "Use schematics to integrate your library with the Angular CLI." } ] @@ -775,68 +775,68 @@ }, { "url": "tutorial/toh-pt0", - "title": "Create a Project", + "title": "Create a project", "tooltip": "Creating the application shell" }, { "url": "tutorial/toh-pt1", - "title": "1. The Hero Editor", + "title": "1. The hero editor", "tooltip": "Part 1: Build a simple editor" }, { "url": "tutorial/toh-pt2", - "title": "2. Display a List", + "title": "2. Display a list", "tooltip": "Part 2: Build a master/detail page with a list of heroes." }, { "url": "tutorial/toh-pt3", - "title": "3. Create a Feature Component", + "title": "3. Create a feature component", "tooltip": "Part 3: Refactor the master/detail views into separate components." }, { "url": "tutorial/toh-pt4", - "title": "4. Add Services", + "title": "4. Add services", "tooltip": "Part 4: Create a reusable service to manage hero data." }, { "url": "tutorial/toh-pt5", - "title": "5. Add Navigation", + "title": "5. Add navigation", "tooltip": "Part 5: Add the Angular router and navigate among the views." }, { "url": "tutorial/toh-pt6", - "title": "6. Get Data from a Server", + "title": "6. Get data from a server", "tooltip": "Part 6: Use HTTP to retrieve and save hero data." } ] }, { "url": "guide/forms", - "title": "Building a Template-driven Form", + "title": "Building a template-driven form", "tooltip": "Create a template-driven form using directives and Angular template syntax." }, { - "title": "Angular Libraries", + "title": "Angular libraries", "tooltip": "Extending Angular with shared libraries.", "children": [ { "url": "guide/libraries", - "title": "Libraries Overview", + "title": "Libraries overview", "tooltip": "Understand how and when to use or create libraries." }, { "url": "guide/using-libraries", - "title": "Using Published Libraries", + "title": "Using published libraries", "tooltip": "Integrate published libraries into an app." }, { "url": "guide/creating-libraries", - "title": "Creating Libraries", + "title": "Creating libraries", "tooltip": "Extend Angular by creating, publishing, and using your own libraries." }, { "url": "guide/angular-package-format", - "title": "Angular Package Format", + "title": "Angular package format", "tooltip": "Information about the Angular Package Format." } ] @@ -860,7 +860,7 @@ "children": [ { "url": "guide/releases", - "title": "Release Practices", + "title": "Release practices", "tooltip": "Angular versioning, release, support, and deprecation policies and practices." }, { @@ -870,12 +870,12 @@ }, { "url": "guide/browser-support", - "title": "Browser Support", + "title": "Browser support", "tooltip": "Browser support and polyfills guide." }, { "url": "guide/update-to-latest-version", - "title": "Update to Version 14", + "title": "Update to version 14", "tooltip": "Support to update your application to version 14" }, { @@ -889,22 +889,22 @@ "children": [ { "url": "guide/upgrade", - "title": "Upgrading Instructions", + "title": "Upgrade instructions", "tooltip": "Incrementally upgrade an AngularJS application to Angular." }, { "url": "guide/upgrade-setup", - "title": "Setup for Upgrading from AngularJS", + "title": "Setup for upgrading from AngularJS", "tooltip": "Use code from the Angular QuickStart seed as part of upgrading from AngularJS." }, { "url": "guide/upgrade-performance", - "title": "Upgrading for Performance", + "title": "Upgrading for performance", "tooltip": "Upgrade from AngularJS to Angular in a more flexible way." }, { "url": "guide/ajs-quick-reference", - "title": "AngularJS-Angular Concepts", + "title": "AngularJS to Angular concepts", "tooltip": "Learn how AngularJS concepts and techniques map to Angular." } ] @@ -916,31 +916,31 @@ "tooltip": "Reference guides for Angular features and tools.", "children": [ { - "title": "Conceptual Reference", + "title": "Conceptual reference", "tooltip": "Reference documentation that explains how Angular features work.", "children": [ { - "title": "Angular Concepts", + "title": "Angular concepts", "tooltip": "Introduction to basic concepts for Angular applications.", "children": [ { "url": "guide/architecture", - "title": "Intro to Basic Concepts", + "title": "Intro to basic concepts", "tooltip": "Basic building blocks of Angular applications." }, { "url": "guide/architecture-modules", - "title": "Intro to Modules", + "title": "Intro to modules", "tooltip": "About NgModules." }, { "url": "guide/architecture-components", - "title": "Intro to Components", + "title": "Intro to components", "tooltip": "About Components, Templates, and Views." }, { "url": "guide/architecture-next-steps", - "title": "Next Steps", + "title": "Next steps", "tooltip": "Beyond the basics." }, { @@ -966,22 +966,22 @@ "children": [ { "url": "guide/file-structure", - "title": "Project File Structure", + "title": "Project file structure", "tooltip": "How your Angular workspace looks on your filesystem." }, { "url": "guide/workspace-config", - "title": "Workspace Configuration", + "title": "Workspace configuration", "tooltip": "The \"angular.json\" file contains workspace and project configuration defaults for Angular CLI commands." }, { "url": "guide/npm-packages", - "title": "npm Dependencies", + "title": "npm dependencies", "tooltip": "Description of npm packages required at development time and at runtime." }, { "url": "guide/typescript-configuration", - "title": "TypeScript Configuration", + "title": "TypeScript configuration", "tooltip": "TypeScript configuration for Angular developers." }, { @@ -998,7 +998,7 @@ "children": [ { "url": "guide/ngmodules", - "title": "NgModules Introduction", + "title": "NgModules introduction", "tooltip": "Use NgModules to make your apps efficient." }, { @@ -1008,37 +1008,37 @@ }, { "url": "guide/bootstrapping", - "title": "Launching Apps with a Root Module", + "title": "Launching apps with a root module", "tooltip": "Tell Angular how to construct and bootstrap the app in the root \"AppModule\"." }, { "url": "guide/frequent-ngmodules", - "title": "Frequently Used NgModules", + "title": "Frequently used NgModules", "tooltip": "Introduction to the most frequently used NgModules." }, { "url": "guide/module-types", - "title": "Types of Feature Modules", + "title": "Types of feature modules", "tooltip": "Description of the different types of feature modules." }, { "url": "guide/entry-components", - "title": "Entry Components", + "title": "Entry components", "tooltip": "All about entry components in Angular." }, { "url": "guide/feature-modules", - "title": "Feature Modules", + "title": "Feature modules", "tooltip": "Create feature modules to organize your code." }, { "url": "guide/providers", - "title": "Providing Dependencies", + "title": "Providing dependencies", "tooltip": "Providing dependencies to NgModules." }, { "url": "guide/singleton-services", - "title": "Singleton Services", + "title": "Singleton services", "tooltip": "Creating singleton services." }, { @@ -1064,12 +1064,12 @@ "children": [ { "url": "guide/observables", - "title": "Observables Overview", + "title": "Observables overview", "tooltip": "Using observables to pass values synchronously or asynchronously." }, { "url": "guide/rx-library", - "title": "The RxJS Library", + "title": "The RxJS library", "tooltip": "A library for reactive programming using observables to compose asynchronous or callback-based code." }, { @@ -1079,12 +1079,12 @@ }, { "url": "guide/practical-observable-usage", - "title": "Practical Usage", + "title": "Practical usage", "tooltip": "Domains in which observables are particularly useful." }, { "url": "guide/comparing-observables", - "title": "Compare to Other Techniques", + "title": "Compare to other techniques", "tooltip": "How observables compare to promises and other message passing techniques." } ] @@ -1095,7 +1095,7 @@ "children": [ { "url": "guide/dependency-injection-in-action", - "title": "DI in Action", + "title": "DI in action", "tooltip": "Techniques for dependency injection." } ] @@ -1112,19 +1112,19 @@ "url": "cli" }, { - "title": "Usage Analytics", + "title": "Usage analytics", "tooltip": "For administrators, guide to gathering usage analytics from your users.", "url": "cli/usage-analytics-gathering" } ] }, { - "title": "API Reference", + "title": "API reference", "tooltip": "Details of the Angular packages, classes, interfaces, and other types.", "url": "api" }, { - "title": "Error Reference", + "title": "Error reference", "tooltip": "Details of the errors that can be thrown by Angular.", "children": [ { @@ -1135,7 +1135,7 @@ ] }, { - "title": "Extended Diagnostic Reference", + "title": "Extended diagnostic reference", "tooltip": "Details of extended diagnostics that can be emitted by the Angular compiler", "children": [ { @@ -1152,71 +1152,71 @@ }, { "url": "guide/glossary", - "title": "Angular Glossary", + "title": "Angular glossary", "tooltip": "Brief definitions of the most important words in the Angular vocabulary." }, { - "title": "Angular Style and Usage", + "title": "Angular coding style", "tooltip": "Summaries of Angular syntax, coding, and doc styles.", "children": [ { "url": "guide/cheatsheet", - "title": "Quick Reference", + "title": "Quick reference", "tooltip": "A quick guide to common Angular coding techniques." }, { "url": "guide/styleguide", - "title": "Coding Style Guide", + "title": "Coding style guide", "tooltip": "Guidelines for writing Angular code." } ] + } + ] + }, + { + "title": "Documentation contributor 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." }, { - "title": "Documentation 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", - "tooltip": "Keep Angular content up-to-date by reviewing topics for accuracy." - }, - { - "url": "guide/updating-search-keywords", - "title": "Updating search keywords", - "tooltip": "Help users find the content they need by adding additional search keywords." - }, - { - "url": "guide/updating-content-github-ui", - "title": "Updating content using GitHub UI", - "tooltip": "Update topics in the browser through the GitHub user interface." - }, - { - "url": "guide/docs-style-guide", - "title": "Documentation Style Guide", - "tooltip": "Style guide for documentation authors." - }, - { - "url": "guide/docs-lint-errors", - "title": "Resolving documentation linter messages", - "tooltip": "More information about documentation lint errors." - }, - { - "url": "guide/localizing-angular", - "title": "Angular doc localization guidelines", - "tooltip": "Learn about the guidelines for localizing Angular documentation." - }, - { - "url": "guide/localized-documentation", - "title": "Localized documentation", - "tooltip": "A list of localized versions of the Angular documentation", - "hidden": true - } - ] + "url": "guide/reviewing-content", + "title": "Reviewing documentation", + "tooltip": "Keep Angular content up-to-date by reviewing topics for accuracy." + }, + { + "url": "guide/updating-search-keywords", + "title": "Updating search keywords", + "tooltip": "Help users find the content they need by adding additional search keywords." + }, + { + "url": "guide/updating-content-github-ui", + "title": "Updating content using GitHub UI", + "tooltip": "Update topics in the browser through the GitHub user interface." + }, + { + "url": "guide/docs-style-guide", + "title": "Documentation style guide", + "tooltip": "Style guide for documentation authors." + }, + { + "url": "guide/docs-lint-errors", + "title": "Resolving documentation linter messages", + "tooltip": "More information about documentation lint errors." + }, + { + "url": "guide/localizing-angular", + "title": "Angular doc localization guidelines", + "tooltip": "Learn about the guidelines for localizing Angular documentation." + }, + { + "url": "guide/localized-documentation", + "title": "Localized documentation", + "tooltip": "A list of localized versions of the Angular documentation", + "hidden": true } ] } @@ -1232,12 +1232,12 @@ }, { "url": "resources", - "title": "Resource Listing", + "title": "Resource listing", "tooltip": "Angular tools, training, and blogs from around the web." }, { "url": "presskit", - "title": "Press Kit", + "title": "Press kit", "tooltip": "Press contacts, logos, and branding." }, { @@ -1247,7 +1247,7 @@ }, { "url": "analytics", - "title": "Usage Analytics", + "title": "Usage analytics", "tooltip": "Angular Usage Analytics" } ]