Skip to content

[Management] Update management landing page copy#166732

Merged
alisonelizabeth merged 9 commits intoelastic:mainfrom
alisonelizabeth:management/copy_updates
Oct 2, 2023
Merged

[Management] Update management landing page copy#166732
alisonelizabeth merged 9 commits intoelastic:mainfrom
alisonelizabeth:management/copy_updates

Conversation

@alisonelizabeth
Copy link
Copy Markdown
Contributor

@alisonelizabeth alisonelizabeth commented Sep 19, 2023

Fixes #163997

Note: The "Endpoints" card copy mentioned in the issue will be added in a separate PR. Also, I'm getting clarification on the "Logs" card for Observability; if we need to add it, it can be done via a separate PR.

Screenshot 2023-09-19 at 9 46 44 AM

@alisonelizabeth alisonelizabeth marked this pull request as ready for review September 19, 2023 17:17
@alisonelizabeth alisonelizabeth requested a review from a team as a code owner September 19, 2023 17:17
@alisonelizabeth alisonelizabeth added Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more t// release_note:skip Skip the PR/issue when compiling release notes labels Sep 19, 2023
@elasticmachine
Copy link
Copy Markdown
Contributor

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

@alisonelizabeth alisonelizabeth added the ui-copy Review of UI copy with docs team is recommended label Sep 19, 2023
@alisonelizabeth alisonelizabeth changed the title [Update management page copy [Management] Update management landing page copy Sep 19, 2023
Copy link
Copy Markdown
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.

🚀

@lcawl
Copy link
Copy Markdown
Member

lcawl commented Sep 21, 2023

IMO the description for the "Connectors" is still possibly confusing for folks who are seeking the search-related connectors. What about something like "Configure connections to third party systems for use in cases and rules."

@shanisagiv1

@alisonelizabeth
Copy link
Copy Markdown
Contributor Author

IMO the description for the "Connectors" is still possibly confusing for folks who are seeking the search-related connectors. What about something like "Configure connections to third party systems for use in cases and rules."

I'm happy to update the copy to this. @gchaps wdyt?

@gchaps
Copy link
Copy Markdown
Contributor

gchaps commented Sep 22, 2023

+1 to

Configure connections to third party systems for use in cases and rules.

Copy link
Copy Markdown
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

In looking over this, I felt that the intro was a too short and the descriptions read better when they are 2 lines. Here are my suggestions. I am interested in what others think.

Intro

Manage data and indices, oversee rules and connectors, organize saved objects and files, and create API keys in a central location.

Cards

Configure and maintain your Elasticsearch indices for data storage and retrieval.

Pivot your data or copy the latest documents into an entity-centric index.

Remove fields, extract values, and perform transformations on your data.

Identify, analyze, and process your data using advanced data analysis.

Manage and view the Logstash event processing pipeline from inputs to outputs.

Detect conditions in apps across Kibana and trigger actions.

Configure connections to third party systems for use in cases and rules.

Manage your saved dashboards, maps, data views, and Canvas workloads.

Monitor the generation of PDF, PNG and CSV reports.

Organize, search, and filter your saved objects by specific criteria.

@lcawl @sixstringcode

@shanisagiv1
Copy link
Copy Markdown

++
I think since it's under the "Alert & Insights" it's clear that the connectors refer to the alerts but fine with this update.

But since the ML is not part of this section anymore (as it is in stateful).. I'd remove the word "insights" and keep it just "Alerts" - wdyt?

@gchaps
Copy link
Copy Markdown
Contributor

gchaps commented Sep 26, 2023

+1 to removing "Insights" from the category name.

@alisonelizabeth
Copy link
Copy Markdown
Contributor Author

@gchaps thanks for the review! I believe I addressed all the feedback. Mind taking another look?

Screenshot 2023-09-26 at 9 19 40 PM

Copy link
Copy Markdown
Contributor

@gchaps gchaps left a comment

Choose a reason for hiding this comment

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

Canvas workloads > Canvas workpads. Sorry about that.

Otherwise, text LGTM.

@lcawl, @sixstringcode What do you think of the new intro and shorter text in the cards?

@lcawl
Copy link
Copy Markdown
Member

lcawl commented Sep 27, 2023

IMO we should try to remove the "Kibana" reference from the Rules intro. How about something like "Define when to generate alerts and notifications".

Likewise I don't think the "Reporting" app enables you to do any monitoring. How about: "Manage generated PDF, PNG and CSV reports".

@sixstringcode
Copy link
Copy Markdown

++ I think since it's under the "Alert & Insights" it's clear that the connectors refer to the alerts but fine with this update.

But since the ML is not part of this section anymore (as it is in stateful).. I'd remove the word "insights" and keep it just "Alerts" - wdyt?

I think we should keep it, I'll be adding a few things for Security. Entity Risk only make sense if it still says insights

@sixstringcode
Copy link
Copy Markdown

IMO we should try to remove the "Kibana" reference from the Rules intro. How about something like "Define when to generate alerts and notifications".

Likewise I don't think the "Reporting" app enables you to do any monitoring. How about: "Manage generated PDF, PNG and CSV reports".

+1 I have been actively removing references to Kibana as well. It doesn't have any context in the new serverless IA's.

@sixstringcode
Copy link
Copy Markdown

@gchaps the new shorter ones look much better. It's VERY minor, but I could see modifying Data Views a little: "Create and manage data you explore from Elasticsearch" or something like that. Object feels like a technical detail we don't need.

We should also capture the ones we haven't added yet here. Advanced Settings we have already discussed, but it looks like we will add Maps, Entity Risk and Visualize Library for Security Projects. We'll need copy for those also. #167453

@gchaps
Copy link
Copy Markdown
Contributor

gchaps commented Sep 27, 2023

@sixstringcode How about one of these:

Create and manage the data you retrieved for exploration.
Create and manage the Elasticsearch data you retrieved for exploration.

@alisonelizabeth
Copy link
Copy Markdown
Contributor Author

alisonelizabeth commented Sep 28, 2023

I've addressed the latest feedback in 271ca6e.

@sixstringcode please advise on the final copy for Data Views.

We should also capture the ones we haven't added yet here. Advanced Settings we have already discussed, but it looks like we will add Maps, Entity Risk and Visualize Library for Security Projects. We'll need copy for those also. #167453

I'm 100% on finalizing copy for these new cards, however, I think the actual code change is out of scope for this PR.

@gchaps
Copy link
Copy Markdown
Contributor

gchaps commented Sep 28, 2023

@szabosteve gave me a minor edit to the ML card description so that the word "data" is not repeated:

Identify, analyze, and process your data using advanced analysis techniques.

@sixstringcode
Copy link
Copy Markdown

I've addressed the latest feedback in 271ca6e.

@sixstringcode please advise on the final copy for Data Views.

We should also capture the ones we haven't added yet here. Advanced Settings we have already discussed, but it looks like we will add Maps, Entity Risk and Visualize Library for Security Projects. We'll need copy for those also. #167453

I'm 100% on finalizing copy for these new cards, however, I think the actual code change is out of scope for this PR.

Fair, I'll take care of them on #167453

@sixstringcode
Copy link
Copy Markdown

@sixstringcode How about one of these:

Create and manage the data you retrieved for exploration.
Create and manage the Elasticsearch data you retrieved for exploration.

I know it's being picky, but the data comes from Elasticsearch. It's really is a filter of the same data. Retrieved makes it sound like it's been moved or copied. Maybe selected or defined?

@alisonelizabeth
Copy link
Copy Markdown
Contributor Author

Final copy feedback applied via 9c01f33

@kibana-ci
Copy link
Copy Markdown

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #13 / Alerting APIs Alerting rules "after each" hook for "should retry when appropriate"
  • [job] [logs] FTR Configs #51 / serverless security UI Configure Case "before all" hook in "Configure Case"

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
management 71.1KB 71.2KB +73.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
serverlessObservability 43.5KB 43.5KB +9.0B
serverlessSearch 30.2KB 30.2KB +9.0B
total +18.0B

History

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

@alisonelizabeth alisonelizabeth merged commit 972d1da into elastic:main Oct 2, 2023
@alisonelizabeth alisonelizabeth deleted the management/copy_updates branch October 2, 2023 16:22
@kibanamachine kibanamachine added v8.11.0 backport:skip This PR does not require backporting labels Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR does not require backporting 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 t// ui-copy Review of UI copy with docs team is recommended v8.11.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Management] Improve copy in Management landing page

9 participants