5 lines
4.2 KiB
JSON
5 lines
4.2 KiB
JSON
{
|
|
"id": "guide/updating-search-keywords",
|
|
"title": "Updating search keywords",
|
|
"contents": "\n\n\n<div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/aio/content/guide/updating-search-keywords.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-search-keywords\">Updating search keywords<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/updating-search-keywords#updating-search-keywords\"><i class=\"material-icons\">link</i></a></h1>\n<p>In documentation, being able to find the content you need is equally as important as the content itself. In <a href=\"https://angular.io/\">angular.io</a>, users can discover content in several ways, including:</p>\n<ul>\n<li>Organic search results, such as through <a href=\"https://google.com/\">google.com</a></li>\n<li>The left navigation bar, also known as sidenav</li>\n<li>Using the search box in the header</li>\n</ul>\n<p>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.</p>\n<h2 id=\"before-you-begin\">Before you begin<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/updating-search-keywords#before-you-begin\"><i class=\"material-icons\">link</i></a></h2>\n<p>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 <a href=\"https://github.com/angular/angular/blob/master/CONTRIBUTING.md\">Contributing to Angular</a> guide available if you're filing your first pull request in the repository.</p>\n<h2 id=\"updating-search-keywords-1\">Updating search keywords<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/updating-search-keywords#updating-search-keywords-1\"><i class=\"material-icons\">link</i></a></h2>\n<p>To update search keywords:</p>\n<ol>\n<li>\n<p>Navigate to the topic to which you want to update search keywords.</p>\n</li>\n<li>\n<p>Decide what search keywords you'd like to add to the topic. For information on how to format keywords, see <a href=\"guide/updating-search-keywords#format\">Search keywords format</a>.</p>\n</li>\n<li>\n<p>Update the <code>@searchKeywords</code> tag, either through the <a href=\"guide/updating-content-github-ui\">GitHub user interface</a> or through Angular's <a href=\"https://github.com/angular/angular/blob/master/CONTRIBUTING.md#submit-pr\">standard pull request process</a>.</p>\n<p>If a topic does not have a <code>@searchKeywords</code> tag, you can add it to the end of the topic.</p>\n</li>\n</ol>\n<a id=\"format\"></a>\n<h2 id=\"search-keywords-format\">Search keywords format<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/updating-search-keywords#search-keywords-format\"><i class=\"material-icons\">link</i></a></h2>\n<p>You add search keywords to a topic using the <code>@searchKeywords</code> tag. This tag takes a set of single words, separated by spaces. The tag and the keywords must be enclosed in curly brackets (<code>{...}</code>). For example:</p>\n<code-example>\n {@searchKeywords route router routing navigation}\n</code-example>\n\n \n</div>\n\n<!-- links to this doc:\n - guide/contributors-guide-overview\n - guide/updating-content-github-ui\n-->\n<!-- links from this doc:\n - guide/updating-content-github-ui\n - guide/updating-search-keywords#before-you-begin\n - guide/updating-search-keywords#format\n - guide/updating-search-keywords#search-keywords-format\n - guide/updating-search-keywords#updating-search-keywords\n - guide/updating-search-keywords#updating-search-keywords-1\n - https://angular.io/\n - https://github.com/angular/angular/blob/master/CONTRIBUTING.md\n - https://github.com/angular/angular/blob/master/CONTRIBUTING.md#submit-pr\n - https://github.com/angular/angular/edit/master/aio/content/guide/updating-search-keywords.md?message=docs%3A%20describe%20your%20change...\n - https://google.com/\n-->"
|
|
} |