[Index Management][Serverless Search] Add a link for searchable content to the mappings tab on the details page #165107
Assignees
Labels
enhancement
New value added to drive a business result
Feature:Index Management
Index and index templates UI
Team:Kibana Management
Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more
Comments
yuliacech
added
enhancement
|
Pinging @elastic/platform-deployment-management (Team:Deployment Management) |
1 task
yuliacech
added a commit
that referenced
this issue
Aug 29, 2023
## Summary Addresses #164572 This PR implements the mappings displayed in the Mappings tab of the index details page. The mappings are loaded from the existing route `api/index_management/mapping/:indexName`. There is a loading indicator and an error prompt for the API request. There is a link to the mappings docs on the right side of the tab. We need to add an Ent Search specific docs link to the right side of the tab which will be addressed as a separate PR ([issue](#165107)). Also any potential performance issues with displaying the mappings object in the code block will be addressed in a separate PR ([issue](#165112)). ### Screenshots #### Small mappings object <img width="1590" alt="Screenshot 2023-08-29 at 15 54 33" src="https://github.com/elastic/kibana/assets/6585477/1b2b950c-446c-4534-8606-94df548ef2ab"> #### Large mappings object <img width="1576" alt="Screenshot 2023-08-29 at 15 54 20" src="https://github.com/elastic/kibana/assets/6585477/35933fec-eb8d-439c-9cec-e03a3b7dd938"> #### Loading <img width="1336" alt="Screenshot 2023-08-29 at 17 07 17" src="https://github.com/elastic/kibana/assets/6585477/4e723b72-2437-45c3-8e0e-54028bd3944b"> #### Error loading mappings <img width="1337" alt="Screenshot 2023-08-29 at 17 07 44" src="https://github.com/elastic/kibana/assets/6585477/2f611081-f11f-41b1-b66e-3086927b1bf0"> ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
bryce-b
pushed a commit
to bryce-b/kibana
that referenced
this issue
Sep 19, 2023
## Summary Addresses elastic#164572 This PR implements the mappings displayed in the Mappings tab of the index details page. The mappings are loaded from the existing route `api/index_management/mapping/:indexName`. There is a loading indicator and an error prompt for the API request. There is a link to the mappings docs on the right side of the tab. We need to add an Ent Search specific docs link to the right side of the tab which will be addressed as a separate PR ([issue](elastic#165107)). Also any potential performance issues with displaying the mappings object in the code block will be addressed in a separate PR ([issue](elastic#165112)). ### Screenshots #### Small mappings object <img width="1590" alt="Screenshot 2023-08-29 at 15 54 33" src="https://github.com/elastic/kibana/assets/6585477/1b2b950c-446c-4534-8606-94df548ef2ab"> #### Large mappings object <img width="1576" alt="Screenshot 2023-08-29 at 15 54 20" src="https://github.com/elastic/kibana/assets/6585477/35933fec-eb8d-439c-9cec-e03a3b7dd938"> #### Loading <img width="1336" alt="Screenshot 2023-08-29 at 17 07 17" src="https://github.com/elastic/kibana/assets/6585477/4e723b72-2437-45c3-8e0e-54028bd3944b"> #### Error loading mappings <img width="1337" alt="Screenshot 2023-08-29 at 17 07 44" src="https://github.com/elastic/kibana/assets/6585477/2f611081-f11f-41b1-b66e-3086927b1bf0"> ### Checklist - [x] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
yuliacech
added a commit
that referenced
this issue
Sep 21, 2023
…age (#166754) ## Summary Fixes #166103 This PR implements the logic to render summaries added via the extension service on the new index details page. Currently, only the ILM plugin registers a summary for an index. The extension service will probably be refactored when working on #165107. I needed to convert the component `IndexLifecycleSummary` from the class component to the function component. Otherwise there were errors while rendering the page and I was not able to check for `null` to not render an empty card. ### Screenshots #### When no ILM info or ILM plugin is disabled (no changes to the Overview tab) <img width="1029" alt="Screenshot 2023-09-19 at 18 51 14" src="https://github.com/elastic/kibana/assets/6585477/1f619580-415a-4704-befc-a75a3a37efe6"> #### When there is ILM policy <img width="1027" alt="Screenshot 2023-09-19 at 18 51 32" src="https://github.com/elastic/kibana/assets/6585477/05105dbf-e6ca-4a1d-ae53-bd42ec030974">
yuliacech
changed the title
9 tasks
yuliacech
added a commit
that referenced
this issue
Nov 10, 2023
#170906) ## Summary Fixes #165107 This PR adds a function to the extensions service in Index Management to register additional content that is rendered in the bottom right corner under the mappings docs link. This PR also adds a panel with the link to the ingest pipelines search docs for the serverless search project. ### Screenshots <img width="1398" alt="Screenshot 2023-11-08 at 21 51 28" src="https://github.com/elastic/kibana/assets/6585477/f6aeb5f6-1844-4fde-85d4-6aafe58484f9"> ### Checklist - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
jillguyonnet
pushed a commit
to jillguyonnet/kibana
that referenced
this issue
Nov 16, 2023
elastic#170906) ## Summary Fixes elastic#165107 This PR adds a function to the extensions service in Index Management to register additional content that is rendered in the bottom right corner under the mappings docs link. This PR also adds a panel with the link to the ingest pipelines search docs for the serverless search project. ### Screenshots <img width="1398" alt="Screenshot 2023-11-08 at 21 51 28" src="https://github.com/elastic/kibana/assets/6585477/f6aeb5f6-1844-4fde-85d4-6aafe58484f9"> ### Checklist - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] Any UI touched in this PR is usable by keyboard only (learn more about [keyboard accessibility](https://webaim.org/techniques/keyboard/)) - [ ] Any UI touched in this PR does not create any new axe failures (run axe in browser: [FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/), [Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US)) - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This renders correctly on smaller devices using a responsive layout. (You can test this [in your browser](https://www.browserstack.com/guide/responsive-testing-on-local-server)) - [ ] This was checked for [cross-browser compatibility](https://www.elastic.co/support/matrix#matrix_browsers) ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Follow up to #164572
After #165038 is merged, we need to follow up by adding a functionality for displaying an Search specific docs link in the mappings tab on the new details page. The link should be displayed in serverless for the search project type. We should plan and build it so that the serverless search plugin can add their content which might be more dynamic in the future (for example adding a Search specific tab).
The link should go to https://www.elastic.co/guide/en/enterprise-search/8.9/ingest-pipelines.html
Screenshot
The text was updated successfully, but these errors were encountered: