This repository has been archived on 2022-07-12. You can view files and clone it, but cannot push or open issues or pull requests.
opencase/config/optional/tour.tour.search-api-index.yml
2022-06-03 12:02:45 +02:00

99 lines
4.1 KiB
YAML

uuid: 974dd8fd-6286-4386-b88f-e9b32fffbb03
langcode: en
status: true
dependencies:
module:
- search_api
_core:
default_config_hash: vrJLX_BEpVcWa6OU7FvRAUfErBOxQBhPtzuKeNo4M2M
id: search-api-index
label: 'Information about an index'
module: search_api
routes:
-
route_name: entity.search_api_index.canonical
tips:
search-api-index-introduction:
id: search-api-index-introduction
plugin: text
label: 'Information about an index'
weight: 1
body: 'This page shows a summary of a search index and its status.'
search-api-index-index-status:
id: search-api-index-index-status
plugin: text
label: 'Index status'
weight: 2
selector: .search-api-index-status
body: 'This gives a summary about how many items are known for this index, and how many have been indexed in their latest version. Items that are not indexed yet cannot be found by searches.'
search-api-index-status:
id: search-api-index-status
plugin: text
label: Status
weight: 3
selector: .search-api-index-summary--status
body: 'Shows whether the index is currently enabled or disabled.'
search-api-index-datasources:
id: search-api-index-datasources
plugin: text
label: Datasources
weight: 4
selector: .search-api-index-summary--datasource
body: 'Lists all datasources that are enabled for this index.'
search-api-index-tracker:
id: search-api-index-tracker
plugin: text
label: Tracker
weight: 5
selector: .search-api-index-summary--tracker
body: 'The tracker used by the index. Only one ("Default") is available by default.'
search-api-index-server:
id: search-api-index-server
plugin: text
label: Server
weight: 6
selector: .search-api-index-summary--server
body: 'If the index is attached to a server, this server is listed here.'
search-api-index-server-index-status:
id: search-api-index-server-index-status
plugin: text
label: 'Server index status'
weight: 7
selector: .search-api-index-summary--server-index-status
body: 'For enabled indexes, the number of items that can actually be retrieved from the server is listed here. For reasons why this number might differ from the number under "Index status", <a href="https://www.drupal.org/docs/8/modules/search-api/getting-started/frequently-asked-questions#server-index-status">see the module''s documentation</a>.'
search-api-index-cron-batch-size:
id: search-api-index-cron-batch-size
plugin: text
label: 'Cron batch size'
weight: 8
selector: .search-api-index-summary--cron-batch-size
body: 'The number of items that will be indexed at once during cron runs.'
search-api-index-index-now:
id: search-api-index-remove
plugin: text
label: 'Start indexing now'
weight: 9
selector: '#edit-index'
body: 'The "Start indexing now" form allows indexing items manually right away, with a batch process. Otherwise, items are only indexed during cron runs. The form might be disabled if indexing is currently not possible for some reason, or not necessary.'
search-api-index-tracking:
id: search-api-index-tracking
plugin: text
label: 'Track items for index'
weight: 10
selector: '#edit-tracking'
body: 'In certain situations, the index''s tracker doesn''t have the latest state of the items available for indexing. This will be automatically rectified during cron runs, but can also be manually triggered here, with the "Track now" button.'
search-api-index-reindex:
id: search-api-index-reindex
plugin: text
label: 'Queue all items for reindexing'
weight: 11
selector: '#edit-reindex'
body: 'This will queue all items on this index for reindexing. Previously indexed data will remain on the search server, so searches on this index will continue to yield results.'
search-api-index-clear:
id: search-api-index-clear
plugin: text
label: 'Clear all indexed data'
weight: 12
selector: '#edit-clear'
body: 'This will remove all indexed content for this index from the search server and queue it for reindexing. Searches on this index will not return any results until items are reindexed.'