Repository navigation
Update integration policy and agent policy pages for the new Add integration flow - #9055
vishaangelova wants to merge 4 commits into
Conversation
✅ Elastic Docs Style Checker (Vale)No issues found on modified lines! The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale. |
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
cf53131 to
4f5df45
Compare
4f5df45 to
a3aba59
Compare
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
08af45c to
0fe5c6f
Compare
1b88f6d to
30fea17
Compare
8c12ca0 to
aa6a1bc
Compare
aa6a1bc to
a33b4ad
Compare
…gration flow Co-authored-by: Cursor <cursoragent@cursor.com>
3fb9b1a to
37f8e1a
Compare
Docs review summaryIssue satisfactionPartially satisfied by design. This PR covers the integration policy and agent policy pages. The description assigns the Security, Fleet and ingest, and Observability pages to #9056, #9251, and #9252, so issue #8153 is complete only after all four PRs merge. Review coverage
|
Co-authored-by: Cursor <cursoragent@cursor.com>
|
|
||
| The integration's details open on the **Overview** page. | ||
|
|
||
| ## Tabs in an integration's details [integration-details-tabs] |
There was a problem hiding this comment.
I think this section is the most important info that we can provide users and everything before it is already self-explained in the UI/UX. I might be missing some context though. What are your thoughts on trimming this page and repurposing it to describe the tabs only @vishaangelova?
There was a problem hiding this comment.
We need to describe the steps, because unfortunately, it's no longer self-evident how to access the integration's details (and additional tabs). Also I linked to this doc from a number of other places in order not to bloat those pages with additional steps and explanations for how to access the integration's details/tabs on the different versions. Soo.. no, I don't think I can trim this page.
To see what I mean, go to Integrations in 9.6.0 deployment or on Serverless, then select an integration (which is not a content package). It gets you straight to the integration configuration page, and you have to click around to get to the tabs. The only easy way is if you've already installed the integration. Then you can go to "Installed integrations" > select the integration, which then opens the Overview tab.
There was a problem hiding this comment.
Although seeing Brandon's comment, I don't think my linking to this section actually worked :D I also realize maybe it wouldn't bloat the steps as much as I thought initially, so I'll update the how-to docs to include the additional steps.
That said, I still think having the "Open an integration's details" section here is good. It describes the two ways you can reach the integration tabs, which we don't have elsewhere, and as I mentioned, from 9.6+ it won't be so straightforward to get there in all cases.
| Install AWS integration assets to load index templates, ingest pipelines, and dashboards into {{kib}}: | ||
|
|
||
| 1. Find **Integrations** in the navigation menu or use the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). | ||
| 2. Search for **AWS**, then [open the integration's details](/reference/fleet/open-integration-details.md). | ||
| 3. Select the **Settings** tab and click **Install AWS**. In the confirmation dialog, click **Install AWS**. | ||
| 4. Install Amazon Data Firehose integration assets in Kibana. |
There was a problem hiding this comment.
This is pretty out of date. A few things:
Searching for "AWS" actually isn't that helpful. The integration I want doesn't even show up in the first 20+ results. But I'm not sure how we fix this.
After I select AWS, there's no way to open the integration details that is intuitive
The two options I found are to either:
- Click "View documentation" which then opens a pop up where I can click "Integration details"
- Click the back button which then allows me to select the integration
Now that I'm on the settings page, I can click install AWS
But is this even the right thing?
Why wouldn't we just send folks straight to the firehose integration?
NVM I see why users need the AWS integration assets. My above points still stand.
There was a problem hiding this comment.
Hmm I guess I didn't consider that this might be fixed by elastic/kibana#303762. Is that the case? It doesn't look like it but I might be wrong.
There was a problem hiding this comment.
Yes, the way to add an integration has changed from 9.6: clicking a tile gets you directly to the integration's configuration page, so I thought we could document how to open the integration's details and tabs in a separate doc, and link to it from the steps...
But from your feedback, I realize this didn't solve the problem :) I also admit that having to go to a separate page for additional couple of clicks isn't good UX. I initially thought if I added this info here, it would bloat the steps quite a bit, and linking would work better (for maintaining the content, too), but I was mistaken. This could really be a one-line step scoped with an applies_to.
I checked your PR, and it seemed like a very good solution!:) I didn't know you could do that from the global search! It could work — at least until the onboardingEnabled flag isn't turned on (and elastic/kibana#298829 starts to impact the workflow). Looks like this might happen in 9.7, not 9.6. But whenever it does, maybe it's better not to depend on the global search in these docs, so we don't have to update them later?
Relates to #8153. Part of a set of PRs for this issue, split by docs set:
The PRs can merge in any order. Close #8153 after all four merge.
Summary
Starting in 9.6 (and in Serverless), selecting an integration tile opens the Add page instead of the integration's Overview page (kibana#287384, kibana#298254, kibana#299010). Pages that relied on the tile to reach the integration's tabs now link to a new page that explains how to open an integration's details.
While checking the add page against the Kibana source, I found steps that were outdated regardless of the tile change: step numbers that shift when the Deployment step appears (9.4+), no mention of the Elastic managed option, an interstitial that's no longer shown after saving, and edit steps that pointed to a tab that doesn't exist. The same edit steps were duplicated on the edit and delete page, so this PR fixes them there and links to it from the add page.
Changes
add-integration-to-policy.md: version-scoped steps for the new tile flow, plus the fixes above.open-integration-details.md(new): how to open an integration's details in each version, the privileges needed, and what each tab is for.edit-delete-integration-policy.md: now the main page for editing and deleting integration policies, with the tab name corrected to Integration policies.agent-policy.md, the nginx examples, Fleet Server on Kubernetes and in mixed mode): steps for the Add integration to policy flyout (9.1+), with a short note for 9.0. The nginx screenshots of the old flow are removed.Verified against source
Checked against the Kibana source for 9.0 through
main, and tested on 9.6.0 and Serverless:Readto open the details, FleetReadfor the Integration policies tab, FleetAllfor Configs, and Fleet and IntegrationsAllto add, edit, or delete integration policies.No agent policies, in every version from 9.0.Note for reviewers
Add Elastic Agent to your hosts currently doesn't open the Add agent flyout. kibana#303762 fixes this (labeled 9.5.7, 9.6.1, 9.7.0), so the step documents the fixed behavior.
Generative AI disclosure
Tool(s) and model(s) used: Cursor with Claude Opus 5.5