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
This is a roadmap for creating a Kibana developer doc and reorganizing the user and admin content based on task.
Goal
Our current docs are organized by how the feature appears in the Kibana side navigation. This isn't ideal for our users--lots of good content is buried under generic headings. We'll reorganize the content into a developer and user guide and make information easier to find. As we implement this task-based structure, we'll flesh out the docs with more use cases and examples and embed introductory videos for beginning users. Because writing is the responsibility of the entire team, we'll provide templates to help everyone structure their docs and improve consistency.
User and admin guide
Here is the proposed top-level structure for the User guide
Introduction
Get started
Set up Kibana
Get data into Kibana
Visualize & explore
Extend your use case
Make your data responsive
Advanced data modeling
Manage your cluster data
Monitor your cluster health
Stack development tools
REST APIs
Plugins
Release Notes
Developer guide
Content for the developer guide is discussed in a separate issue.
Phase 1: Developer guide
Create a developer guide that incorporates the ideas discussed in this issue.
Move appropriate existing content into dev folder: [DOCS] Create developer guide part #44954 - [ ] Fix any places in other repos where we "include" the existing dev files, since their paths will have changed
Update landing pages to link to developer doc. See the mockup here.
This is a roadmap for creating a Kibana developer doc and reorganizing the user and admin content based on task.
Goal
Our current docs are organized by how the feature appears in the Kibana side navigation. This isn't ideal for our users--lots of good content is buried under generic headings. We'll reorganize the content into a developer and user guide and make information easier to find. As we implement this task-based structure, we'll flesh out the docs with more use cases and examples and embed introductory videos for beginning users. Because writing is the responsibility of the entire team, we'll provide templates to help everyone structure their docs and improve consistency.
User and admin guide
Here is the proposed top-level structure for the User guide
Developer guide
Content for the developer guide is discussed in a separate issue.
Phase 1: Developer guide
Create a developer guide that incorporates the ideas discussed in this issue.
- [ ] Fix any places in other repos where we "include" the existing dev files, since their paths will have changedPhase 2: User and admin guide
Create a task-based user/admin guide.
The text was updated successfully, but these errors were encountered: