Skip to content

Clean up the Fleet OpenAPI readme#143143

Merged
dedemorton merged 2 commits intoelastic:mainfrom
dedemorton:cleanup_API_readme
Oct 12, 2022
Merged

Clean up the Fleet OpenAPI readme#143143
dedemorton merged 2 commits intoelastic:mainfrom
dedemorton:cleanup_API_readme

Conversation

@dedemorton
Copy link
Copy Markdown
Contributor

@dedemorton dedemorton commented Oct 11, 2022 •
edited by kibanamachine
Loading

Summary

Fixed a few problems in the readme file that were kind of annoying me. I didn't worry about things like passive voice that I normally fix because this file seems consistent with others in the Kibana repo. Here is what the changed file looks like:

image

Summary of changes:

  • Removed the screen captures because they aren't clickable or IMO necessary (just something that could get out-of-date).
  • Removed the link to the MrinDoc viewer because they misspell "deprecated," and it looks unprofessional. It looks like the project hasn’t been touched in 4 years, so I’d prefer not to provide the link. I think one link to the Swagger UI is good enough.
    image
  • Removed extraneous whitespace from the command examples because it was causing rendering issues.

TO DO:

  • Should I also remove the experimental note?

Checklist

Delete any items that are not applicable to this PR.

@dedemorton dedemorton added the Team:Fleet Team label for Observability Data Collection Fleet team label Oct 11, 2022
@dedemorton dedemorton self-assigned this Oct 11, 2022
@dedemorton dedemorton requested a review from a team as a code owner October 11, 2022 22:19
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Oct 11, 2022

Pinging @elastic/fleet (Team:Fleet)

@dedemorton dedemorton changed the title Cleanup the Fleet OpenAPI readme Clean up the Fleet OpenAPI readme Oct 11, 2022
@dedemorton dedemorton added backport This PR is a backport of another PR release_note:skip Skip the PR/issue when compiling release notes v8.5.0 labels Oct 11, 2022
@dedemorton
Copy link
Copy Markdown
Contributor Author

dedemorton commented Oct 11, 2022

@jen-huang Should I remove the experimental note while I have this file open?

kpollich
kpollich approved these changes Oct 12, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@kpollich kpollich 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 - thank you for cleaning this up.

Should I also remove the experimental note?

No, the Fleet API is still considered experimental. We're actively pursuing a formalized beta designation as part of the process laid out in #123150.

@nchaulet has some draft docs for the new agent/package policy APIs here: https://github.com/elastic/observability-docs/issues/2180. Once these land we'll cut over from Experimental -> Beta for the Fleet API.

I'll make a note in the GA meta issue to audit and update any public facing docs we have for the Fleet API or its associated OpenAPI spec here to replace Experimental with Beta when ready.

🚀

@dedemorton dedemorton added auto-backport-next and removed backport This PR is a backport of another PR labels Oct 12, 2022
@dedemorton
Copy link
Copy Markdown
Contributor Author

dedemorton commented Oct 12, 2022

Thanks! Getting the info from https://github.com/elastic/observability-docs/issues/2180 into the docs is on my list.

@dedemorton
Copy link
Copy Markdown
Contributor Author

dedemorton commented Oct 12, 2022

Since we aren't going to change the experimental note in this PR, I will backport this to 8.4 too.

@dedemorton dedemorton added v8.4.0 backport:all-open Backport to all branches that could still receive a release labels Oct 12, 2022
@dedemorton dedemorton merged commit 54879f4 into elastic:main Oct 12, 2022
@dedemorton dedemorton deleted the cleanup_API_readme branch October 12, 2022 01:04
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 12, 2022
@dedemorton
Cleanup the Fleet OpenAPI readme (elastic#143143)
f6eb5af 
(cherry picked from commit 54879f4)
This was referenced Oct 12, 2022
Merged
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Oct 12, 2022
@dedemorton
Cleanup the Fleet OpenAPI readme (elastic#143143)
889c2cf 
(cherry picked from commit 54879f4)
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Oct 12, 2022

💔 Some backports could not be created

Status Branch Result
❌ 7.17 Backport failed because of merge conflicts
✅ 8.4
✅ 8.5

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 143143

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Oct 12, 2022
@kibanamachine @dedemorton
Cleanup the Fleet OpenAPI readme (#143143) (#143147)
6407a4f 
(cherry picked from commit 54879f4)

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
kibanamachine added a commit that referenced this pull request Oct 12, 2022
@kibanamachine @dedemorton
Cleanup the Fleet OpenAPI readme (#143143) (#143148)
bd1039d 
(cherry picked from commit 54879f4)

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
@dedemorton
Copy link
Copy Markdown
Contributor Author

dedemorton commented Oct 12, 2022

We don't need this in 7.17, so don't worry about the failed backport.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kpollich kpollich kpollich approved these changes

Assignees

@dedemorton dedemorton

Labels

auto-backport-next backport:all-open Backport to all branches that could still receive a release release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v8.4.0 v8.4.4 v8.5.0 v8.6.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@dedemorton @elasticmachine @kibanamachine @kpollich