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

[Infra] Rename infra "Inventory" to "Infrastructure Inventory" #192324

Closed
smith opened this issue Sep 8, 2024 · 3 comments · Fixed by #193189
Closed

[Infra] Rename infra "Inventory" to "Infrastructure Inventory" #192324

smith opened this issue Sep 8, 2024 · 3 comments · Fixed by #193189
Assignees
Labels
Feature:EntitiesInventory Observability entities inventory feature Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team technical debt Improvement of the software architecture and operational architecture

Comments

@smith
Copy link
Contributor

smith commented Sep 8, 2024

To avoid confusion between the top-level entities inventory and the infra inventory, we should rename "Inventory" to "Infrastructue Inventory" in all places it's used:

Image

Due to the hierarchy it's a little redundant in some places but it will help disambiguate the two.

✔ Acceptance criteria

  • Infra inventory main heading says "Infrastructure Inventory"
  • Infra inventory side bar navigation items say "Infrastructure Inventory"
  • Infra inventory search result items say "Infrastructure Inventory"
  • Infra inventory breadcrumbs say "Infrastructure Inventory"
@smith smith added Feature:EntitiesInventory Observability entities inventory feature Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team technical debt Improvement of the software architecture and operational architecture labels Sep 8, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

@iblancof
Copy link
Contributor

I'm curious to understand where this new top-level entities inventory will be placed and why it might cause confusion.
Could you clarify that? Thank you!

@smith
Copy link
Contributor Author

smith commented Sep 10, 2024

@iblancof on #192322, which is in progress, it's at the top level: Image

In the mockup (see the figma attached to the parent issue of this issue) it's similar:

Image

@kpatticha kpatticha changed the title Rename infra "Inventory" to "Infrastructure Inventory" [Infra] Rename infra "Inventory" to "Infrastructure Inventory" Sep 12, 2024
@Bluefinger Bluefinger self-assigned this Sep 16, 2024
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Sep 20, 2024
…193189)

## Summary

Update the Inventory title terminology to be "Infrastructure Inventory",
in order to differentiate from the incoming top-level "Inventory" page.

<img width="481" alt="Screenshot 2024-09-17 170745"
src="https://github.com/user-attachments/assets/d72dfb6e-fe3b-44d8-b6f0-ae333586ceb4">

Closes elastic#192324

# How to test

- Load Elastic cluster, go to Infrastructure -> Infrastructure Inventory

**Expected**: The side menu link text should match the breadcrumb title
and the main title text for the page.

---------

Co-authored-by: Elastic Machine <[email protected]>
(cherry picked from commit 04c3486)
kibanamachine added a commit that referenced this issue Sep 20, 2024
…&quot; (#193189) (#193523)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Infra] Amend inventory title to &quot;Infrastructure Inventory&quot;
(#193189)](#193189)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Gonçalo Rica Pais da
Silva","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-20T09:41:47Z","message":"[Infra]
Amend inventory title to \"Infrastructure Inventory\" (#193189)\n\n##
Summary\r\n\r\nUpdate the Inventory title terminology to be
\"Infrastructure Inventory\",\r\nin order to differentiate from the
incoming top-level \"Inventory\" page.\r\n\r\n<img width=\"481\"
alt=\"Screenshot 2024-09-17
170745\"\r\nsrc=\"https://github.com/user-attachments/assets/d72dfb6e-fe3b-44d8-b6f0-ae333586ceb4\">\r\n\r\nCloses
#192324 \r\n\r\n# How to test\r\n\r\n- Load Elastic cluster, go to
Infrastructure -> Infrastructure Inventory\r\n\r\n**Expected**: The side
menu link text should match the breadcrumb title\r\nand the main title
text for the page.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic
Machine
<[email protected]>","sha":"04c3486878efed32e99fd4d17c893f69a10ed9ab","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","backport:prev-minor","ci:project-deploy-observability","Team:obs-ux-infra_services"],"title":"[Infra]
Amend inventory title to \"Infrastructure
Inventory\"","number":193189,"url":"https://github.com/elastic/kibana/pull/193189","mergeCommit":{"message":"[Infra]
Amend inventory title to \"Infrastructure Inventory\" (#193189)\n\n##
Summary\r\n\r\nUpdate the Inventory title terminology to be
\"Infrastructure Inventory\",\r\nin order to differentiate from the
incoming top-level \"Inventory\" page.\r\n\r\n<img width=\"481\"
alt=\"Screenshot 2024-09-17
170745\"\r\nsrc=\"https://github.com/user-attachments/assets/d72dfb6e-fe3b-44d8-b6f0-ae333586ceb4\">\r\n\r\nCloses
#192324 \r\n\r\n# How to test\r\n\r\n- Load Elastic cluster, go to
Infrastructure -> Infrastructure Inventory\r\n\r\n**Expected**: The side
menu link text should match the breadcrumb title\r\nand the main title
text for the page.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic
Machine
<[email protected]>","sha":"04c3486878efed32e99fd4d17c893f69a10ed9ab"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193189","number":193189,"mergeCommit":{"message":"[Infra]
Amend inventory title to \"Infrastructure Inventory\" (#193189)\n\n##
Summary\r\n\r\nUpdate the Inventory title terminology to be
\"Infrastructure Inventory\",\r\nin order to differentiate from the
incoming top-level \"Inventory\" page.\r\n\r\n<img width=\"481\"
alt=\"Screenshot 2024-09-17
170745\"\r\nsrc=\"https://github.com/user-attachments/assets/d72dfb6e-fe3b-44d8-b6f0-ae333586ceb4\">\r\n\r\nCloses
#192324 \r\n\r\n# How to test\r\n\r\n- Load Elastic cluster, go to
Infrastructure -> Infrastructure Inventory\r\n\r\n**Expected**: The side
menu link text should match the breadcrumb title\r\nand the main title
text for the page.\r\n\r\n---------\r\n\r\nCo-authored-by: Elastic
Machine
<[email protected]>","sha":"04c3486878efed32e99fd4d17c893f69a10ed9ab"}}]}]
BACKPORT-->

Co-authored-by: Gonçalo Rica Pais da Silva <[email protected]>
iblancof added a commit that referenced this issue Sep 30, 2024
…e nav adjustments (#193533)

## Summary

Closes #192323 and
#193393.

### Plugin enablement
The enablement of the new Inventory plugin was previously managed via
the `xpack.inventory.enabled` setting in kibana.yml. With this PR, we
transition to enabling it through the
`observability:entitycentricexperience` advanced setting.


### Position in side nav
Additionally, this PR includes adjustments to the placement of the new
Inventory page within the side navigation and the addition of the "Tech
Preview" badge in the navigation where it was supported.

|Navigation|Screenshot|
|-|-|
|Stateful classic (first nav)|![Screenshot 2024-09-25 at 11 25
46](https://github.com/user-attachments/assets/54e92632-9931-4f5b-8648-8a32afcd0caf)|
|Stateful classic (O11y)|![Screenshot 2024-09-25 at 11 25
56](https://github.com/user-attachments/assets/ae644eb2-2559-4be0-8659-ef709399a871)|
|Stateful new O11y|![Screenshot 2024-09-25 at 11 27
52](https://github.com/user-attachments/assets/c404232c-2630-4220-9bb8-315b0f0fc55f)|
|Serverless|![Screenshot 2024-09-25 at 11 23
07](https://github.com/user-attachments/assets/7f7e6c79-7f0f-4f7d-8fed-260d73ad4d3f)|


### Global search
A modification was made to the global search to prevent a duplicate
result from appearing during searches by removing the deeplinks when
registering the plugin. The UI changes are shown below.

>[!WARNING]
If this modification causes any other issues, please let me know in a
comment.

|With deeplink (before)|Without deeplink (after)|
|-|-|

|![global_search_with_deeplink](https://github.com/user-attachments/assets/3ef5641c-3add-4892-af2f-46f72ff1722e)|![global_search_without_deeplink](https://github.com/user-attachments/assets/8ad92f27-13a2-4b85-8958-588e597f94d9)|

### Services rename to Service Inventory
Another needed change was to rename the nav item Services to Service
Inventory

>[!NOTE] 
Screenshots were taken before the navigation sorting was agreed with
product, so the "Inventory" item does not appear in the right position.

|Navigation|Screenshot|
|-|-|
|Stateful classic
(O11y)|![services_stateful_classic](https://github.com/user-attachments/assets/25ed1294-40fe-47be-9319-fe294acce8f8)|
|Stateful new
O11y|![services_stateful_new](https://github.com/user-attachments/assets/4ae9495c-56bc-4327-b2f6-b6ac9f68bd21)|

|Serverless|![services_serverless](https://github.com/user-attachments/assets/81ff51f4-3b0e-41fd-b7c6-79e8aa44e575)|

>[!NOTE] 
The rename of infra Inventory to Infrastructure Inventory is being
tracked separately in #192324.


### Tech preview badge in page
Lastly, the "Technical Preview" badge has been added to the page title.

>[!NOTE] 
The screenshot was taken before the navigation sorting was agreed with
product, so the "Inventory" item does not appear in the right position.



![inventory_title_badge](https://github.com/user-attachments/assets/172c5b8e-258e-4127-b792-40910e9dede0)


### Plugin registration in server
To make the Inventory available in the spaces and privileges
configuration the plugin has been registered in the features service.

>[!WARNING]
I lack detailed context in this area, so I’ve added default empty
configurations for most attributes. If any adjustments or improvements
are needed, please let me know.

|Space config|Privileges|
|-|-|
|![Screenshot 2024-09-23 at 10 57
35](https://github.com/user-attachments/assets/1c3a45b6-fd67-4706-8fc4-ee42a9206787)|![Screenshot
2024-09-23 at 10 57
14](https://github.com/user-attachments/assets/a852c15d-133c-459d-be77-2d73e662ffdb)|

---------

Co-authored-by: Kate Patticha <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Sep 30, 2024
…e nav adjustments (elastic#193533)

## Summary

Closes elastic#192323 and
elastic#193393.

### Plugin enablement
The enablement of the new Inventory plugin was previously managed via
the `xpack.inventory.enabled` setting in kibana.yml. With this PR, we
transition to enabling it through the
`observability:entitycentricexperience` advanced setting.

### Position in side nav
Additionally, this PR includes adjustments to the placement of the new
Inventory page within the side navigation and the addition of the "Tech
Preview" badge in the navigation where it was supported.

|Navigation|Screenshot|
|-|-|
|Stateful classic (first nav)|![Screenshot 2024-09-25 at 11 25
46](https://github.com/user-attachments/assets/54e92632-9931-4f5b-8648-8a32afcd0caf)|
|Stateful classic (O11y)|![Screenshot 2024-09-25 at 11 25
56](https://github.com/user-attachments/assets/ae644eb2-2559-4be0-8659-ef709399a871)|
|Stateful new O11y|![Screenshot 2024-09-25 at 11 27
52](https://github.com/user-attachments/assets/c404232c-2630-4220-9bb8-315b0f0fc55f)|
|Serverless|![Screenshot 2024-09-25 at 11 23
07](https://github.com/user-attachments/assets/7f7e6c79-7f0f-4f7d-8fed-260d73ad4d3f)|

### Global search
A modification was made to the global search to prevent a duplicate
result from appearing during searches by removing the deeplinks when
registering the plugin. The UI changes are shown below.

>[!WARNING]
If this modification causes any other issues, please let me know in a
comment.

|With deeplink (before)|Without deeplink (after)|
|-|-|

|![global_search_with_deeplink](https://github.com/user-attachments/assets/3ef5641c-3add-4892-af2f-46f72ff1722e)|![global_search_without_deeplink](https://github.com/user-attachments/assets/8ad92f27-13a2-4b85-8958-588e597f94d9)|

### Services rename to Service Inventory
Another needed change was to rename the nav item Services to Service
Inventory

>[!NOTE]
Screenshots were taken before the navigation sorting was agreed with
product, so the "Inventory" item does not appear in the right position.

|Navigation|Screenshot|
|-|-|
|Stateful classic
(O11y)|![services_stateful_classic](https://github.com/user-attachments/assets/25ed1294-40fe-47be-9319-fe294acce8f8)|
|Stateful new
O11y|![services_stateful_new](https://github.com/user-attachments/assets/4ae9495c-56bc-4327-b2f6-b6ac9f68bd21)|

|Serverless|![services_serverless](https://github.com/user-attachments/assets/81ff51f4-3b0e-41fd-b7c6-79e8aa44e575)|

>[!NOTE]
The rename of infra Inventory to Infrastructure Inventory is being
tracked separately in elastic#192324.

### Tech preview badge in page
Lastly, the "Technical Preview" badge has been added to the page title.

>[!NOTE]
The screenshot was taken before the navigation sorting was agreed with
product, so the "Inventory" item does not appear in the right position.

![inventory_title_badge](https://github.com/user-attachments/assets/172c5b8e-258e-4127-b792-40910e9dede0)

### Plugin registration in server
To make the Inventory available in the spaces and privileges
configuration the plugin has been registered in the features service.

>[!WARNING]
I lack detailed context in this area, so I’ve added default empty
configurations for most attributes. If any adjustments or improvements
are needed, please let me know.

|Space config|Privileges|
|-|-|
|![Screenshot 2024-09-23 at 10 57
35](https://github.com/user-attachments/assets/1c3a45b6-fd67-4706-8fc4-ee42a9206787)|![Screenshot
2024-09-23 at 10 57
14](https://github.com/user-attachments/assets/a852c15d-133c-459d-be77-2d73e662ffdb)|

---------

Co-authored-by: Kate Patticha <[email protected]>
Co-authored-by: kibanamachine <[email protected]>
(cherry picked from commit 26f5e14)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:EntitiesInventory Observability entities inventory feature Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team technical debt Improvement of the software architecture and operational architecture
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants