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] Improves Management section in docs #56669

Merged
merged 3 commits into from
Feb 6, 2020

Conversation

gchaps
Copy link
Contributor

@gchaps gchaps commented Feb 3, 2020

Summary

This PR:

  • Adds that defines Management in the Management intro page
  • Alphabetizes the organization of topics in the Management TOC so it is easier to scan
  • Improves documentation on managing index patterns and fields

[skip ci]

Preview:
http://kibana_56669.docs-preview.app.elstc.co/guide/en/kibana/master/management.html

@gchaps gchaps added Team:Docs v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.5.0 v7.7.0 v7.6.0 labels Feb 3, 2020
@elasticmachine
Copy link
Contributor

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

@gchaps
Copy link
Contributor Author

gchaps commented Feb 4, 2020

run elasticsearch-ci/docs

@@ -1,5 +1,5 @@
[[advanced-options]]
== Setting advanced options
== Advanced Settings
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Advanced Settings or Advanced settings?

@@ -1,30 +1,30 @@
[role="xpack"]
[[index-lifecycle-policies]]
== Index lifecycle policies
== Index Lifecycle Policies
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it Index Lifecycle Policies in the title if it is index lifecycle policies on line 12?

@@ -1,32 +1,32 @@
[[managing-licenses]]
== License management
== License Management

When you install the default distribution of {kib}, you receive a basic license
with no expiration date. For the full list of free features that are included in
the basic license, see https://www.elastic.co/subscriptions[the subscription page].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see or refer to?

A rollup job is a periodic task that aggregates data from indices specified
by an index pattern and rolls it into a new index. Rollup indices are a good way to
compactly store months or years of historical
A rollup job is a periodic task that aggregates data from indices specified
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

A rollup job is a periodic task that aggregates data from indices specified by an index pattern, then rolls the data into a new index.


| <<data-rollups, *Rollup Jobs*>>

Create a job that periodically aggregates data from one or more indices and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

Create a job that periodically aggregates data from one or more indices, then rolls the data into a new, compact index.

The fields for the index pattern are listed in a table. Click a column header to sort the table by that column. Click
the *Controls* button in the rightmost column for a given field to edit the field's properties. You can manually set
the field's format from the *Format* drop-down. Format options vary based on the field's type.
The *Index patterns* UI in *Management* helps you create and manage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we are already in the Management section, could this just say "The Index patterns UI ...."?

status of your license, start a trial, or install a new license.

NOTE: You can start a trial only if your cluster has not already activated a
trial license for the current major product version. For example, if you have
already activated a trial for v6.0, you cannot start a new trial until
already activated a trial for v6.0, you cannot start a new trial until
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v6.0 or version 6.0 or 6.0?


{kib} *Management* provides user interfaces for working with data from remote
clusters and managing the {ccr} process. You can replicate indices from a
{kib} *Management* provides user interfaces for working with data from remote
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

Work with data from remote clusters and manage the {ccr} process.

@@ -1,9 +1,9 @@
[[managing-saved-objects]]
== Saved objects
== Saved Objects

*Saved Objects* helps you keep track of and manage your saved objects. These objects
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of starting all of these sections with "[Feature] helps you...", how about just starting with what the UI helps the user do? So for this one, it would be:

Keep track of and manage your saved objects.

{kib} makes it easy for you to create a rollup job by walking you through
the process. You fill in the name, data flow, and how often you want to roll
up the data. Then you define a date histogram aggregation for the rollup job
and optionally terms, histogram, and metrics aggregations.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and optionally define?

Copy link
Contributor

@KOTungseth KOTungseth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@gchaps
Copy link
Contributor Author

gchaps commented Feb 6, 2020

@elasticmachine merge upstream

@gchaps gchaps merged commit 3c80ea2 into elastic:master Feb 6, 2020
gchaps added a commit to gchaps/kibana that referenced this pull request Feb 6, 2020
* [DOCS] Improves Management section in docs

* [DOCS] Fixes build error

* [DOCS] Incorporates review comments in management docs
gchaps added a commit to gchaps/kibana that referenced this pull request Feb 6, 2020
* [DOCS] Improves Management section in docs

* [DOCS] Fixes build error

* [DOCS] Incorporates review comments in management docs
gchaps added a commit that referenced this pull request Feb 6, 2020
* [DOCS] Improves Management section in docs

* [DOCS] Fixes build error

* [DOCS] Incorporates review comments in management docs
gchaps added a commit that referenced this pull request Feb 6, 2020
* [DOCS] Improves Management section in docs

* [DOCS] Fixes build error

* [DOCS] Incorporates review comments in management docs
@gchaps gchaps deleted the docs/management/revised-intro branch February 6, 2020 21:53
majagrubic pushed a commit to majagrubic/kibana that referenced this pull request Feb 10, 2020
* [DOCS] Improves Management section in docs

* [DOCS] Fixes build error

* [DOCS] Incorporates review comments in management docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.5.0 v7.6.0 v7.7.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants