id to slug

elastic · Jun 4, 2024 · 2f4604d · 2f4604d
1 parent 3060fec
commit 2f4604d
Show file tree

Hide file tree

Showing 44 changed files with 131 additions and 177 deletions.
diff --git a/docs/api-architecture.mdx b/docs/api-architecture.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-architecture
 slug: /search-ui/api/architecture
 title: Architecture
 date: 2022-02-27

diff --git a/docs/api-connectors-app-search.mdx b/docs/api-connectors-app-search.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-connectors-app-search
 slug: /search-ui/api/connectors/app-search
 title: App Search Connector
 date: 2022-02-27

diff --git a/docs/api-connectors-elasticsearch.mdx b/docs/api-connectors-elasticsearch.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-connectors-elasticsearch
 slug: /search-ui/api/connectors/elasticsearch
 title: Elasticsearch Connector
 date: 2022-04-13
@@ -179,7 +178,7 @@ You can restrict access to indices by using an API key. We recommend you create
 
 Search UI supports autocomplete functionality to suggest search terms that provide results. The autocomplete functionality is built on top of the Elasticsearch `suggest` and `bool prefix query` API.
 
-To take advantage of the feature, first update the <DocLink id="api-core-configuration" section="autocomplete-query" text="autocomplete query" /> configuration.
+To take advantage of the feature, first update the <DocLink slug="/search-ui/api/core/configuration" section="autocomplete-query" text="autocomplete query" /> configuration.
 
 Below is an example of what the `autocompleteQuery` may look like.
 
@@ -233,7 +232,7 @@ Below is an example of the mappings for the above example. `title_suggest` is a
 }
 ```
 
-With a combination of this configuration + the <DocLink id="api-react-components-search-box" text="Searchbox" /> component with autocomplete configuration, your users will be able to see suggestions as they type within the search box.
+With a combination of this configuration + the <DocLink slug="/search-ui/api/react/components/search-box" text="Searchbox" /> component with autocomplete configuration, your users will be able to see suggestions as they type within the search box.
 
 ## Node.js Integration
 

diff --git a/docs/api-connectors-site-search.mdx b/docs/api-connectors-site-search.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-connectors-site-search
 slug: /search-ui/api/connectors/site-search
 title: Site Search Connector
 date: 2022-02-27

diff --git a/docs/api-connectors-workplace-search.mdx b/docs/api-connectors-workplace-search.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-connectors-workplace-search
 slug: /search-ui/api/connectors/workplace-search
 title: Workplace Search Connector
 date: 2022-04-18

diff --git a/docs/api-core-actions.mdx b/docs/api-core-actions.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-core-actions
 slug: /search-ui/api/core/actions
 title: Actions
 date: 2022-02-27
@@ -22,7 +21,7 @@ withSearch(({ searchTerm, setSearchTerm }) => ({
 }))(Component);
 ```
 
-See <DocLink id="api-react-with-search" /> for more information.
+See <DocLink slug="/search-ui/api/react/with-search" /> for more information.
 
 There are certain cases where you may need to apply one or more actions at a time. Search UI intelligently
 batches actions into a single API call.

diff --git a/docs/api-core-configuration.mdx b/docs/api-core-configuration.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-core-configuration
 slug: /search-ui/api/core/configuration
 title: Configuration
 description: Search UI Configuration API
@@ -15,7 +14,7 @@ Search UI uses a configuration object to tailor search to your needs. It consist
 
 See below for details on each part.
 
-See <DocLink id="api-react-search-provider" /> page for more information on how to use the configuration with the SearchProvider.
+See <DocLink slug="/search-ui/api/react/search-provider" /> page for more information on how to use the configuration with the SearchProvider.
 
 ## Search Query (QueryConfig)
 
@@ -141,7 +140,7 @@ disjunctiveFacetsAnalyticsTags: ["ignore"];
 
 #### Conditional Faceting
 
-See <DocLink id="guides-conditional-facets" text="Conditional Faceting" /> for more information.
+See <DocLink slug="/search-ui/guides/conditional-facets" text="Conditional Faceting" /> for more information.
 
 ### search_fields
 
@@ -284,7 +283,7 @@ results: {
 | field           | description                                                                                                                                                         |
 | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `resultPerPage` | Optional. Number type. Number of results suggested                                                                                                                  |
-| `result_fields` | Optional. To specify the fields for each result hit. Use same configuration as <DocLink id="api-core-configuration" section="result_fields" text="result fields" /> |
+| `result_fields` | Optional. To specify the fields for each result hit. Use same configuration as <DocLink slug="/search-ui/api/core/configuration" section="result_fields" text="result fields" /> |
 
 ### Suggestions
 
@@ -321,7 +320,7 @@ A different index can be used for the suggestions. Some examples:
 
 Below we are using the `popular_queries` index and performing a prefix match search on the `query.suggest` field. One thing to note, make sure the api-key has access to the index.
 
-See <DocLink id="api-react-components-search-box" text="Example retrieving suggestions from another index" /> for more information.
+See <DocLink slug="/search-ui/api/react/components/search-box" text="Example retrieving suggestions from another index" /> for more information.
 
 ```js
 autocompleteQuery: {

diff --git a/docs/api-core-state.mdx b/docs/api-core-state.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-core-state
 slug: /search-ui/api/core/state
 title: State
 date: 2022-02-27
@@ -50,7 +49,7 @@ It is updated indirectly by invoking an action which results in a new API reques
 | `autocompletedResultsRequestId`     | A unique ID for the current autocompleted search results.                                                                                                                                                                                                                 |
 | `autocompletedSuggestions`          | A keyed object of query suggestions. It's keyed by type since multiple types of query suggestions can be set here.                                                                                                                                                        |
 | `autocompletedSuggestionsRequestId` | A unique ID for the current autocompleted suggestion results.                                                                                                                                                                                                             |
-| `facets`                            | Will be populated if `facets` configured in <DocLink id="api-core-configuration" section="facets" text="Search Query Facets Configuration" />.                                                                                                                            |
+| `facets`                            | Will be populated if `facets` configured in <DocLink slug="/search-ui/api/core/configuration" section="facets" text="Search Query Facets Configuration" />.                                                                                                                            |
 | `rawResponse`                       | The response object received from the API                                                                                                                                                                                                                                 |
 | `requestId`                         | A unique ID for the current search results.                                                                                                                                                                                                                               |
 | `results`                           | An array of result items.                                                                                                                                                                                                                                                 |

diff --git a/docs/api-plugins-analytics-plugin.mdx b/docs/api-plugins-analytics-plugin.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-plugins-analytics-plugin
 slug: /search-ui/api/core/plugins/analytics-plugin
 title: Analytics Plugin
 date: 2023-01-05

diff --git a/docs/api-react-components-error-boundary.mdx b/docs/api-react-components-error-boundary.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-react-components-error-boundary
 slug: /search-ui/api/react/components/error-boundary
 title: ErrorBoundary
 date: 2022-02-27
@@ -26,12 +25,12 @@ import { ErrorBoundary } from "@elastic/react-search-ui";
 | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | className |                                                                                                                                                                              |
 | children  | Content to show if no error has occurred, will be replaced with error messaging if there was an error.                                                                       |
-| view      | Used to override the default view for this Component. See <DocLink id="api-react-components-error-boundary" section="view-customization" text="View customization" /> below. |
+| view      | Used to override the default view for this Component. See <DocLink slug="/search-ui/api/react/components/error-boundary" section="view-customization" text="View customization" /> below. |
 | \*        | Any other property passed will be passed through and available to use in a Custom View                                                                                       |
 
 ### View customization
 
-A complete guide to view customization can be found in the <DocLink id="guides-customizing-styles-and-html" section="customizing-html" text="Customization: Component views and HTML" /> section.
+A complete guide to view customization can be found in the <DocLink slug="/search-ui/guides/customizing-styles-and-html" section="customizing-html" text="Customization: Component views and HTML" /> section.
 
 The following properties are available in the view:
 

diff --git a/docs/api-react-components-facet.mdx b/docs/api-react-components-facet.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-react-components-facet
 slug: /search-ui/api/react/components/facet
 title: Facet
 date: 2022-02-27
@@ -8,7 +7,7 @@ tags: ["facet"]
 
 Show a Facet filter for a particular field.
 
-Must configure the corresponding field in the `SearchProvider` <DocLink id="api-core-configuration" section="facets" text="facets" /> object.
+Must configure the corresponding field in the `SearchProvider` <DocLink slug="/search-ui/api/core/configuration" section="facets" text="facets" /> object.
 
 ### Example
 
@@ -69,12 +68,12 @@ import { MultiCheckboxFacet } from "@elastic/react-search-ui-views";
 | label        | A static label to show in the facet filter.                                                                                                                                                                                                                |
 | show         | The number of facet filter options to show before concatenating with a "Show more" link.                                                                                                                                                                   |
 | isFilterable | Whether or not to show Facet quick filter.                                                                                                                                                                                                                 |
-| view         | Used to override the default view for this Component. See <DocLink id="api-react-components-facet" section="view-customization" text="View customization" /> below.                                                                                        |
+| view         | Used to override the default view for this Component. See <DocLink slug="/search-ui/api/react/components/facet" section="view-customization" text="View customization" /> below.                                                                                        |
 | \*           | Any other property passed will be passed through and available to use in a Custom View                                                                                                                                                                     |
 
 ### View customization
 
-A complete guide to view customization can be found in the <DocLink id="guides-customizing-styles-and-html" section="customizing-html" text="Customization: Component views and HTML" /> section.
+A complete guide to view customization can be found in the <DocLink slug="/search-ui/guides/customizing-styles-and-html" section="customizing-html" text="Customization: Component views and HTML" /> section.
 
 The following properties are available in the view:
 

diff --git a/docs/api-react-components-paging-info.mdx b/docs/api-react-components-paging-info.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-react-components-paging-info
 slug: /search-ui/api/react/components/paging-info
 title: PagingInfo
 date: 2022-02-27
@@ -24,12 +23,12 @@ import { PagingInfo } from "@elastic/react-search-ui";
 | Name      | Description                                                                                                                                                               |
 | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | className |                                                                                                                                                                           |
-| view      | Used to override the default view for this Component. See <DocLink id="api-react-components-paging-info" section="view-customization" text="View customization" /> below. |
+| view      | Used to override the default view for this Component. See <DocLink slug="/search-ui/api/react/components/paging-info" section="view-customization" text="View customization" /> below. |
 | \*        | Any other property passed will be passed through and available to use in a Custom View                                                                                    |
 
 ### View customization
 
-A complete guide to view customization can be found in the <DocLink id="guides-customizing-styles-and-html" section="customizing-html" text="Customization: Component views and HTML" /> section.
+A complete guide to view customization can be found in the <DocLink slug="/search-ui/guides/customizing-styles-and-html" section="customizing-html" text="Customization: Component views and HTML" /> section.
 
 The following properties are available in the view:
 

diff --git a/docs/api-react-components-paging.mdx b/docs/api-react-components-paging.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-react-components-paging
 slug: /search-ui/api/react/components/paging
 title: Paging
 date: 2022-02-27
@@ -24,12 +23,12 @@ import { Paging } from "@elastic/react-search-ui";
 | Name      | Description                                                                                                                                                          |
 | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | className |                                                                                                                                                                      |
-| view      | Used to override the default view for this Component. See <DocLink id="api-react-components-paging" section="view-customization" text="View customization" /> below. |
+| view      | Used to override the default view for this Component. See <DocLink slug="/search-ui/api/react/components/paging" section="view-customization" text="View customization" /> below. |
 | \*        | Any other property passed will be passed through and available to use in a Custom View                                                                               |
 
 ### View customization
 
-A complete guide to view customization can be found in the <DocLink id="guides-customizing-styles-and-html" section="customizing-html" text="Customization: Component views and HTML" /> section.
+A complete guide to view customization can be found in the <DocLink slug="/search-ui/guides/customizing-styles-and-html" section="customizing-html" text="Customization: Component views and HTML" /> section.
 
 The following properties are available in the view:
 

diff --git a/docs/api-react-components-result.mdx b/docs/api-react-components-result.mdx
@@ -1,5 +1,4 @@
 ---
-id: api-react-components-result
 slug: /search-ui/api/react/components/result
 title: Result
 date: 2022-02-27
@@ -38,8 +37,7 @@ import { Result } from "@elastic/react-search-ui";
 ### Configuring search queries
 
 Certain aspects of search results can be configured in `SearchProvider`, using the `searchQuery` configuration, such as
-term highlighting and search fields. See the <DocLink
-  id="api-core-configuration"
+term highlighting and search fields. See the <DocLink slug="/search-ui/api/core/configuration"
   section="search-query-queryconfig"
   text="Search Query Configuration"
 /> guide
@@ -55,12 +53,12 @@ for more information.
 | clickThroughTags        | Tags to send to analytics API when tracking clickthrough.                                                                                                            |
 | urlField                | Name of field to use as the href from each result.                                                                                                                   |
 | result                  | Type: `SearchResult`. An object representing the search result to render.                                                                                            |
-| view                    | Used to override the default view for this Component. See <DocLink id="api-react-components-result" section="view-customization" text="View customization" /> below. |
+| view                    | Used to override the default view for this Component. See <DocLink slug="/search-ui/api/react/components/result" section="view-customization" text="View customization" /> below. |
 | \*                      | Any other property passed will be passed through and available to use in a Custom View                                                                               |
 
 ### View customization
 
-A complete guide to view customization can be found in the <DocLink id="guides-customizing-styles-and-html" section="customizing-html" text="Customization: Component views and HTML" /> section.
+A complete guide to view customization can be found in the <DocLink slug="/search-ui/guides/customizing-styles-and-html" section="customizing-html" text="Customization: Component views and HTML" /> section.
 
 Example: