Developer guide v1

[peterschretlen]

This is a meta issue for getting the Kibana developer guide to "v1.0" state.

Guiding principals

• The primary target audience for these docs are internal plugin developers. It's okay to put some information in there that is irrelevant to external plugin developers (and call it out as such), but try not to put information that is irrelevant to plugin developers (for example, avoid detailed, internal plugin architecture).

• Think outside-in, and high to low-level. The top left navigation items should be targeted towards a newbie, and as that person goes down through all the docs, they will get more and more familiar with Kibana plugin development. Hence, the lowest-level docs, API docs, should be the last thing in the left nav.

• We’ve been leaning on the divio documentation guide as a reference. Explanation topics put under Key Concepts or Overview and put the higher-level concepts first.

Notes

• REST API docs will not be included in this Mission, as plugin developers should prefer to use typescript APIs provided by the plugin.

cc @stacey-gammon @kobelb @joshdover

[elasticmachine]

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

[stacey-gammon]

One note here is that it's a common point of confusion that API documentation means our typescript Plugin APIs, not REST APIs. We'll have to think of where/how to incorporate the REST API docs.

[KOTungseth]

@stacey-gammon are you referring to these REST API docs - https://www.elastic.co/guide/en/kibana/current/api.html? In the new docs system, we've found a home for them, and my plan is to start migrating them after 7.11 is released. But if not, sorry for the noise!

[TinaHeiligers]

Team | Owner
Core | @TinaHeiligers

@stacey-gammon ack. @joshdover we'll need the whole core team to help out with this effort.