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

Remove vis and AggConfig docs #26072

Closed
wants to merge 2 commits into from
Closed

Conversation

timroes
Copy link
Contributor

@timroes timroes commented Nov 22, 2018

Summary

This PR removes the documentation on vis and aggConfig. 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 strikethroughs to remove checklist items you don't feel are applicable to this PR.

For maintainers

@timroes timroes added Team:Docs Feature:Visualizations Generic visualization features (in case no more specific feature label is available) v7.0.0 Team:Visualizations Visualization editors, elastic-charts and infrastructure v6.6.0 labels Nov 22, 2018
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Copy link
Member

@markov00 markov00 left a 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?

@timroes
Copy link
Contributor Author

timroes commented Nov 22, 2018

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.

@ppisljar
Copy link
Member

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 ? :)

Copy link
Member

@ppisljar ppisljar left a comment

Choose a reason for hiding this comment

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

LGTM

@snide snide added v7.0.1 and removed v7.0.0 labels Apr 10, 2019
@timroes
Copy link
Contributor Author

timroes commented Jun 20, 2019

Closing as stalled and outdated

@timroes timroes closed this Jun 20, 2019
@timroes timroes deleted the remove-vis-doc branch June 20, 2019 18:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Visualizations Generic visualization features (in case no more specific feature label is available) Team:Docs Team:Visualizations Visualization editors, elastic-charts and infrastructure v6.7.0 v7.0.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants