-
Notifications
You must be signed in to change notification settings - Fork 8.1k
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
Remove vis and AggConfig docs #26072
Conversation
Pinging @elastic/kibana-app |
💚 Build Succeeded |
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.
Instead of removing it completely, don't you think we can leave it blank with a small description says that it is outdated, code is changing fast and it's better to check the jsdocs directly on the specific files? Just to avoid people questions about: here where is the vis documentation? why it was removed?
I would rather have people reading this PR and seeing it, because referring to the code will bring us the very same problem: A file is moved (or even just renamed from .js -> .ts) and suddenly those links are no longer valid. |
i agree with marco, i wouldn't expect someone in 2 months wanting to develop something with kibana to go thru our git history, find this PR, ... lets make life easier for our users ? :) |
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.
LGTM
Closing as stalled and outdated |
Summary
This PR removes the documentation on
vis
andaggConfig
. Both are going to change drastically (or rather vanish completely) with the change towards using Canvas expressions for all visualizations (#19813). It has also shown in the past, that even though our JSDoc stays updated, this documentation often were not aligned properly with the code, why we decided to remove it for now. We hope to bring a similar documentation (on the new APIs) back in a more stable way, via properly compiling JSDoc.Checklist
Use
strikethroughsto remove checklist items you don't feel are applicable to this PR.[ ] This was checked for cross-browser compatibility, including a check against IE11[ ] Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support[ ] Documentation was added for features that require explanation or tutorials[ ] Unit or functional tests were updated or added to match the most common scenarios[ ] This was checked for keyboard-only and screenreader accessibilityFor maintainers
[ ] This was checked for breaking API changes and was labeled appropriately[ ] This includes a feature addition or change that requires a release note and was labeled appropriately