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

[skip-ci] Temporarily remove visualization development docs. #58141

Merged
merged 2 commits into from
Mar 11, 2020

Conversation

lukeelmers
Copy link
Member

@lukeelmers lukeelmers commented Feb 20, 2020

Summary

Based on discussions with @flash1293, @elastic/kibana-app-arch, and others, we've decided to temporarily remove the visualization development docs starting in 7.5 to prevent confusion amongst both Elastic & community developers.

The APIs for creating custom visualizations are in a state of heavy churn as they are being migrated to the new platform, and large refactorings have been happening across minor releases in the 7.x series.

We expect to be able to re-add proper documentation later in 7.x when the visualizations plugin has been migrated and the APIs are in a more stable state, but in the interim the old docs are more likely to cause confusion than to be useful.

For those who would like to follow along with progress on the visualizations plugin in the meantime, I'd recommend the following resources:

@lukeelmers lukeelmers added review Team:Docs Feature:Visualizations Generic visualization features (in case no more specific feature label is available) v8.0.0 Team:AppArch release_note:skip Skip the PR/issue when compiling release notes v7.5.0 v7.7.0 v7.6.0 labels Feb 20, 2020
@lukeelmers lukeelmers requested review from flash1293 and a team February 20, 2020 16:00
@lukeelmers lukeelmers self-assigned this Feb 20, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@flash1293
Copy link
Contributor

flash1293 commented Feb 20, 2020

Do we want to leave a paragraph about being aware of this gap and it’s recommended to wait for another version till upgrading plugins? Unsure whether that’s even the best suggestion we can make but it feels to me like we should at least explain the absence in a few words.

@lizozom
Copy link
Contributor

lizozom commented Feb 22, 2020

@elasticmachine merge upstream

Copy link
Contributor

@lizozom lizozom left a comment

Choose a reason for hiding this comment

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

LGTM, but I agree with @flash1293

Copy link
Contributor

@flash1293 flash1293 left a comment

Choose a reason for hiding this comment

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

Placeholder message LGTM, thanks for taking care of this

@weand
Copy link

weand commented Jun 18, 2020

is there an ETA when an official documentation will be added back? a lot of transition work seems to be done already.

@axelv
Copy link

axelv commented Feb 4, 2021

Any pointers to some preliminary documentation or example code to get started developing a visualisation plugin on the NP?

@lukeelmers
Copy link
Member Author

@axelv The best place for examples right now is probably the source code itself - you might check out a smaller visualization plugin like the one for the metric visualization.

I believe work is already underway on either documentation or a how-to blog post, but @elastic/kibana-app would be able to confirm.

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) release_note:skip Skip the PR/issue when compiling release notes review Team:Docs v7.5.0 v7.6.0 v7.7.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants