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

Create Kibana GitHub page for temporarily publishing UI Framework documentation #9544

Closed
cjcenizal opened this issue Dec 17, 2016 · 2 comments
Labels
Team:Platform-Design Team Label for Kibana Design Team. Support the Analyze group of plugins.

Comments

@cjcenizal
Copy link
Contributor

cjcenizal commented Dec 17, 2016

We need to surface UI Framework documentation in an easily-accessible location, so that engineers can use the framework effectively.

In the long-term, we want to publish these docs on elastic.co (#9457), but that will take a lot of work. and our UI Framework isn't in a state where we're prepared to officially support it for plugin developers, so maybe it doesn't make sense to publish it in a prominent "official" place like elastic.co right now.

A GitHub page seems like a great short-term solution because it's in an obvious location, it's tied to the Kibana repo, and it's easy to deploy.

Questions:

  1. Does this make sense / is it a good idea? Are there alternatives?
  2. If this is a suitable approach, then is it appropriate for UI Framework-specific docs to live at elastic.github.io/kibana? (See elastic.github.io/kibana-ui-framework to see what the content would look like).
  3. If not, then is it sufficient to just put the UI Framework docs behind a general Kibana landing page at that URL?
  4. Would we ever publish other documentation here which is useful to us internally and which we want to share publicly (for the sake of transparency), but we don't want to give it the official stamp of approval by putting it on elastic.co, e.g. plugin API docs?
@cjcenizal cjcenizal added Team:Platform-Design Team Label for Kibana Design Team. Support the Analyze group of plugins. discuss labels Dec 17, 2016
@cjcenizal cjcenizal changed the title Create Kibana GitHub page for temporarily publishing documentation Create Kibana GitHub page for temporarily publishing UI Framework documentation Dec 17, 2016
@cjcenizal
Copy link
Contributor Author

CC @uboness

@cjcenizal cjcenizal removed the discuss label Dec 19, 2016
@cjcenizal
Copy link
Contributor Author

Closing this in favor of #9457

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Platform-Design Team Label for Kibana Design Team. Support the Analyze group of plugins.
Projects
None yet
Development

No branches or pull requests

1 participant