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

[DOCS][Roadmap] Reorg Kibana Guide #44907

Closed
9 of 13 tasks
gchaps opened this issue Sep 5, 2019 · 2 comments
Closed
9 of 13 tasks

[DOCS][Roadmap] Reorg Kibana Guide #44907

gchaps opened this issue Sep 5, 2019 · 2 comments
Labels
Meta Team:Docs WIP Work in progress

Comments

@gchaps
Copy link
Contributor

gchaps commented Sep 5, 2019

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.

Phase 2: User and admin guide

Create a task-based user/admin guide.

@gchaps gchaps added Team:Docs WIP Work in progress labels Sep 5, 2019
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs

@KOTungseth
Copy link
Contributor

KOTungseth commented Dec 6, 2019

This is mostly done, so we are closing. When the new docs vision is approved, we'll create a new roadmap.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Meta Team:Docs WIP Work in progress
Projects
None yet
Development

No branches or pull requests

3 participants