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

Improve deprecated API list, and update api docs #106942

Merged

Conversation

stacey-gammon
Copy link
Contributor

@stacey-gammon stacey-gammon commented Jul 28, 2021

Deprecated api list is now shorter - one row per referenced API, and only shows the first 10 links plus "x more" if required.

Also added a deprecated API list by API which lists the plugins that still reference it.

Screen Shot 2021-07-27 at 8 10 09 PM

Notes:

Given that packages aren't included in these docs anyway, these types may not be capturable anyway.

cc @lizozom

@stacey-gammon stacey-gammon added release_note:skip Skip the PR/issue when compiling release notes v7.15.0 v8.0.0 labels Jul 28, 2021
@stacey-gammon stacey-gammon requested a review from spalger July 28, 2021 14:20
Copy link
Contributor

@spalger spalger left a comment

Choose a reason for hiding this comment

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

Looked through the TS changes and the generated output looks good.

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

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

@stacey-gammon stacey-gammon merged commit 2832231 into elastic:master Jul 28, 2021
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jul 30, 2021
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 106942 or prevent reminders by adding the backport:skip label.

1 similar comment
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 106942 or prevent reminders by adding the backport:skip label.

@stacey-gammon stacey-gammon added the auto-backport Deprecated - use backport:version if exact versions are needed label Aug 2, 2021
@kibanamachine
Copy link
Contributor

💔 Backport failed

Status Branch Result
7.x Commit could not be cherrypicked due to conflicts

To backport manually run:
node scripts/backport --pr 106942

stacey-gammon added a commit to stacey-gammon/kibana that referenced this pull request Aug 2, 2021
* Code to adjust deprecated api list

* updated docs

* fix and update tests
# Conflicts:
#	api_docs/core.json
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_field_formats.mdx
#	api_docs/data_index_patterns.json
#	api_docs/data_index_patterns.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations.mdx
#	api_docs/kibana_react.mdx
#	api_docs/security_solution.json
#	api_docs/security_solution.mdx
stacey-gammon added a commit that referenced this pull request Aug 2, 2021
* Code to adjust deprecated api list

* updated docs

* fix and update tests
# Conflicts:
#	api_docs/core.json
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_field_formats.mdx
#	api_docs/data_index_patterns.json
#	api_docs/data_index_patterns.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations.mdx
#	api_docs/kibana_react.mdx
#	api_docs/security_solution.json
#	api_docs/security_solution.mdx
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Aug 2, 2021
streamich pushed a commit to vadimkibana/kibana that referenced this pull request Aug 8, 2021
* Code to adjust deprecated api list

* updated docs

* fix and update tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed release_note:skip Skip the PR/issue when compiling release notes v7.15.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants