Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Index Management] Update the columns width in the index templates and component templates tables #175337

Merged
merged 5 commits into from
Jan 26, 2024

Conversation

yuliacech
Copy link
Contributor

@yuliacech yuliacech commented Jan 23, 2024

Summary

Fixes #174946

This PR tries to improve the readability of the index templates and component templates lists by setting the columns with text information to be wider and to not truncate the text. The badges in the name columns are also set to inline which makes the word breaking in the columns better imho. See screenshots with before and after on a smaller screen (just before the tables switch from rows to a mobile view).

Screenshots

Index templates

Before
Screenshot 2024-01-24 at 18 41 15

After
Screenshot 2024-01-26 at 15 45 22

Component templates

Before
Screenshot 2024-01-24 at 18 41 23

After
Screenshot 2024-01-24 at 18 40 47

Checklist

Delete any items that are not applicable to this PR.

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

For maintainers

@yuliacech yuliacech added Feature:Index Management Index and index templates UI Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more release_note:skip Skip the PR/issue when compiling release notes labels Jan 23, 2024
@yuliacech
Copy link
Contributor Author

/ci

@yuliacech yuliacech marked this pull request as ready for review January 24, 2024 17:43
@yuliacech yuliacech requested a review from a team as a code owner January 24, 2024 17:43
@elasticmachine
Copy link
Contributor

Pinging @elastic/platform-deployment-management (Team:Deployment Management)

Copy link
Member

@sabarasaba sabarasaba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes lgtm, didnt test locally 🚀

My only feedback is regarding index templates, you can indeed read all the values now but we went from a compact table to one with extremely tall rows. I'd argue that perhaps in smaller screen devices not all columns need to be present since they can be explored in the details flyout. I think the "components" column could perhaps be hidden in order to improve legibility of the data and make it tidier, since right now with all the limited space and text-wrapping it makes it quite hard to follow 🤔

@yuliacech
Copy link
Contributor Author

yuliacech commented Jan 26, 2024

Thanks a lot for the feedback, @sabarasaba! Indeed, the Index templates table is now too tall, so I've put back the line truncateText: true on the Components column. I think a better solution might be just to display a number of components and add a link to the Component templates list with a corresponding filter enabled, similar to linking backing indices of a data stream. I'll open an issue for that and address in a separate PR (issue opened here).

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
indexManagement 587.3KB 587.4KB +82.0B

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@yuliacech yuliacech merged commit a724ca3 into elastic:main Jan 26, 2024
17 checks passed
@kibanamachine kibanamachine added v8.13.0 backport:skip This commit does not require backporting labels Jan 26, 2024
@yuliacech yuliacech deleted the im/component_templates branch February 15, 2024 12:03
CoenWarmer pushed a commit to CoenWarmer/kibana that referenced this pull request Feb 15, 2024
…d component templates tables (elastic#175337)

## Summary

Fixes elastic#174946 

This PR tries to improve the readability of the index templates and
component templates lists by setting the columns with text information
to be wider and to not truncate the text. The badges in the name columns
are also set to `inline` which makes the word breaking in the columns
better imho. See screenshots with before and after on a smaller screen
(just before the tables switch from rows to a mobile view).

### Screenshots
#### Index templates
Before
<img width="719" alt="Screenshot 2024-01-24 at 18 41 15"
src="https://github.com/elastic/kibana/assets/6585477/2e4e5df2-ae49-48c4-bbeb-28fa2dd86405">


After
<img width="711" alt="Screenshot 2024-01-24 at 18 40 37"
src="https://github.com/elastic/kibana/assets/6585477/39bc524f-d092-491b-b3f9-ffedd39c6fe5">



#### Component templates
Before
<img width="716" alt="Screenshot 2024-01-24 at 18 41 23"
src="https://github.com/elastic/kibana/assets/6585477/7a6f58bf-0478-4c88-a9d2-49b79c6acf60">


After
<img width="718" alt="Screenshot 2024-01-24 at 18 40 47"
src="https://github.com/elastic/kibana/assets/6585477/c08701a5-96e9-4f18-8eb7-49719e3eec6f">



### Checklist

Delete any items that are not applicable to this PR.

- [ ] 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
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] 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&mdash;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&mdash;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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting Feature:Index Management Index and index templates UI release_note:skip Skip the PR/issue when compiling release notes Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more v8.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Index Management] Fix column width in index and component templates tables
5 participants