-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Improve deprecated API list, and update api docs #106942
Conversation
There was a problem hiding this 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.
💚 Build SucceededMetrics [docs]
History
To update your PR or re-run it, just comment with: |
Friendly reminder: Looks like this PR hasn’t been backported yet. |
1 similar comment
Friendly reminder: Looks like this PR hasn’t been backported yet. |
💔 Backport failed
To backport manually run: |
* 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
* 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
* Code to adjust deprecated api list * updated docs * fix and update tests
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.
Notes:
oldFilter
. Read more about why all types referenced in a public type should be exported..Given that packages aren't included in these docs anyway, these types may not be capturable anyway.
cc @lizozom