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

[Fleet] Link to Fleet API docs in relevant UI locations + remove beta tag from Fleet API references #152966

Closed
4 tasks
kpollich opened this issue Mar 8, 2023 · 1 comment · Fixed by #154442
Closed
4 tasks
Assignees
Labels
Team:Fleet Team label for Observability Data Collection Fleet team

Comments

@kpollich
Copy link
Member

kpollich commented Mar 8, 2023

Ref #123150

Fleet/Integrations UI currently points to https://www.elastic.co/guide/en/fleet/master/index.html in a few places where the API is referenced.

We now have proper documentation for the Fleet API at https://www.elastic.co/guide/en/fleet/master/fleet-api-docs.html. We should update any links that are appropriate to point here instead.

We also currently display references to the Fleet API with a beta badge. The Fleet API is going GA in 8.8 so these should be removed in preparation for that release.

image

image

Implementation

Preview Give feedback
@kpollich kpollich added the Team:Fleet Team label for Observability Data Collection Fleet team label Mar 8, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@jillguyonnet jillguyonnet self-assigned this Apr 3, 2023
jillguyonnet added a commit that referenced this issue Apr 12, 2023
### Summary

This PR adds and updates documentation links and removes `beta` badges
for the GA of Fleet API in 8.8.0.

This includes the following changes:
1. Elastic Agent integration settings page, `API reference` tab:
* Update the documentation link to
https://www.elastic.co/guide/en/fleet/master/fleet-api-docs.html.
  * Remove the `beta` badge.
2. `Preview API request` flyout:
  * Add a link to the documentation to the title (cf. screenshots).
  * Remove the `beta` badge.

Closes #152966

### Screenshots

#### Elastic Agent integration settings page, `API reference` tab -
Before

![Screenshot 2023-04-05 at 15 01
21](https://user-images.githubusercontent.com/23701614/230091121-c14e02ce-47d4-4748-9152-84b12597243e.png)

#### Elastic Agent integration settings page, `API reference` tab -
After

![Screenshot 2023-04-05 at 15 00
23](https://user-images.githubusercontent.com/23701614/230091160-cd750443-e42c-4b8b-97a1-c6c89dbf6dda.png)

#### `Preview API request` flyout - Before

![Screenshot 2023-04-11 at 15 56
36](https://user-images.githubusercontent.com/23701614/231193937-7d03e1eb-0781-4983-916a-1e0ab7b63462.png)

#### `Preview API request` flyout - After

![Screenshot 2023-04-11 at 12 53
27](https://user-images.githubusercontent.com/23701614/231193976-cb91c575-bbd5-4c04-85ac-e3564a4121d9.png)

### Steps to test locally

On this branch, start Kibana in dev.

1. Elastic Agent integration settings page, `API reference` tab:
1. Go to
`<localKibanaUrl>/app/integrations/detail/elastic_agent-1.7.0/api-reference`.
2. Check that the `beta` badge is removed and that the `Learn more` link
point to
https://www.elastic.co/guide/en/fleet/master/fleet-api-docs.html.
2. `Preview API request` flyout:
1. Create a new agent policy: give it a name and click `Preview API
request`.
2. Check that the `beta` badge is removed and that the title has a
`Learn more about Fleet API` link that points to
https://www.elastic.co/guide/en/fleet/master/fleet-api-docs.html.
3. Do the same checks when updating an agent policy, creating a package
policy and updating a package policy.

### Checklist

- [ ] 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))
- [ ] 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Fleet Team label for Observability Data Collection Fleet team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants