5 lines
3.3 KiB
JSON
5 lines
3.3 KiB
JSON
{
|
|
"id": "guide/updating-content-github-ui",
|
|
"title": "Updating topics through the GitHub user interface",
|
|
"contents": "\n\n\n<div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/aio/content/guide/updating-content-github-ui.md?message=docs%3A%20describe%20your%20change...\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n</div>\n\n\n<div class=\"content\">\n <h1 id=\"updating-topics-through-the-github-user-interface\">Updating topics through the GitHub user interface<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/updating-content-github-ui#updating-topics-through-the-github-user-interface\"><i class=\"material-icons\">link</i></a></h1>\n<p>This topic describes how to submit pull requests to the Angular repository using GitHub's user interface. If you are unfamiliar with <a href=\"https://git-scm.com/\">Git</a>, you might find this process easier for making changes.</p>\n<div class=\"alert is-important\">\n<p> Using the GitHub user interface for updates is recommended only for small changes to one file at a time, such as fixing typos, <a href=\"guide/reviewing-content\">updating the review date</a> or <a href=\"guide/updating-search-keywords\">updating search keywords</a>.</p>\n</div>\n<p><strong>To update a topic through the GitHub user interface:</strong></p>\n<ol>\n<li>\n<p>Navigate to the topic for which you want to file a pull request.</p>\n</li>\n<li>\n<p>Click the edit icon at the top of the topic.</p>\n<div class=\"lightbox\">\n <img src=\"generated/images/guide/contributors-guide/edit-icon.png\" alt=\"The edit icon for an Angular topic.\" width=\"36\" height=\"36\">\n</div>\n<p>A GitHub page appears, displaying the source of the topic.</p>\n</li>\n<li>\n<p>Update the topic.</p>\n</li>\n<li>\n<p>At the bottom of the screen, update the <strong>Commit changes</strong> box with a description of the change. Use the format <code>docs: <short-description-of-change></code>, where <code><short-description-of-change></code> briefly describes your change. Keep the description under 100 characters. For example:</p>\n<p><code>docs: fix typo in Tour of Heroes pt.1</code></p>\n</li>\n<li>\n<p>Verify that the <strong>create new branch</strong> option is selected, then click <strong>Commit changes</strong>.</p>\n<p>A Pull Request screen opens.</p>\n</li>\n<li>\n<p>Fill out the form in the Pull Request screen. At a minimum, put an <code>x</code> in the <strong>Docs have been added / updated</strong> option and the <strong>Documentation content changes</strong> option.</p>\n</li>\n<li>\n<p>Click <strong>Create pull request</strong>.</p>\n</li>\n</ol>\n<p>At this point, your pull request is added to a list of current requests, which the documentation team reviews weekly.</p>\n\n \n</div>\n\n<!-- links to this doc:\n - guide/contributors-guide-overview\n - guide/reviewing-content\n - guide/updating-search-keywords\n-->\n<!-- links from this doc:\n - guide/reviewing-content\n - guide/updating-content-github-ui#updating-topics-through-the-github-user-interface\n - guide/updating-search-keywords\n - https://git-scm.com/\n - https://github.com/angular/angular/edit/master/aio/content/guide/updating-content-github-ui.md?message=docs%3A%20describe%20your%20change...\n-->"
|
|
} |