You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
Does this make sense / is it a good idea? Are there alternatives?
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).
If not, then is it sufficient to just put the UI Framework docs behind a general Kibana landing page at that URL?
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?
The text was updated successfully, but these errors were encountered:
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
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:
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?The text was updated successfully, but these errors were encountered: