Skip to content

Commit

Permalink
[DOCS] Removed spatial references (elastic#59595)
Browse files Browse the repository at this point in the history
* [DOCS] Removed ss above spatial references

* Removed above from n numeral formatting page
  • Loading branch information
KOTungseth committed Mar 9, 2020
1 parent ec53283 commit e70cc73
Show file tree
Hide file tree
Showing 17 changed files with 95 additions and 273 deletions.
23 changes: 0 additions & 23 deletions docs/apm/advanced-queries.asciidoc

This file was deleted.

17 changes: 0 additions & 17 deletions docs/canvas/canvas-function-reference.asciidoc

This file was deleted.

97 changes: 0 additions & 97 deletions docs/dev-tools/console/console.asciidoc

This file was deleted.

6 changes: 3 additions & 3 deletions docs/dev-tools/searchprofiler/more-complicated.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ POST test/_bulk
// CONSOLE
--

. From the {searchprofiler}, enter "test" in the Index field above the query editor to restrict profiled
. From the {searchprofiler}, enter "test" in the *Index* field to restrict profiled
queries to the `test` index.

. Replace the default `match_all` query in the query editor with a query that has two sub-query
Expand Down Expand Up @@ -66,7 +66,7 @@ components and includes a simple aggregation, like the example below.
// NOTCONSOLE
--

. Click *Profile* to profile the query and visualize the results.
. Click *Profile* to profile the query and visualize the results.
. Select the shard to view the query details.
+
[role="screenshot"]
Expand Down Expand Up @@ -100,5 +100,5 @@ Select the name of the shard to view the aggregation details and timing breakdow
image::dev-tools/searchprofiler/images/gs10.png["Drilling into the first shard's details"]

For more information about how the {searchprofiler} works, how timings are calculated, and
how to interpret various results, see
how to interpret various results, see
{ref}/search-profile-queries.html[Profiling queries].
4 changes: 2 additions & 2 deletions docs/developer/core/development-dependencies.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ module.exports = window.angular;

What this shim does is fairly simple if you go line by line:

. makes sure that jQuery is loaded before angular (which actually runs the shim above)
. makes sure that jQuery is loaded before angular (which actually runs the shim)
. load the angular.js file from the node_modules directory
. load the angular-elastic plugin, a plugin we want to always be included whenever we import angular
. use the `ui/modules` module to add the module exported by angular-elastic as a dependency to the `kibana` angular module
. finally, export the window.angular variable. This means that writing `import angular from 'angular';` will properly set the angular variable to the angular library, rather than undefined which is the default behavior.
. finally, export the window.angular variable. This means that writing `import angular from 'angular';` will properly set the angular variable to the angular library, rather than undefined which is the default behavior.
4 changes: 2 additions & 2 deletions docs/developer/core/development-modules.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ certain components. Here is a breakdown of those modules:
the required modules and import them were they are actually necessary.

- *`import 'ui/autoload/all'`*
Imports all of the above modules
Imports all of the modules

[float]
==== Resolving Require Paths
Expand Down Expand Up @@ -69,4 +69,4 @@ Here is how import/require statements are resolved to a file:
** path/index + '.js'
** path/index + '.json'
** path/index
* if none of the above paths matches then an error is thrown
* if none of the paths matches then an error is thrown
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ This outputs a `en.json` file inside the `translations` directory. To localize o
Checking i18n does the following:

* Checks all existing labels for violations.
* Takes translations from `.i18nrc.json` and compares them to the messages extracted and validated at the step above and:
* Takes translations from `.i18nrc.json` and compares them to the messages extracted and validated.
** Checks for unused translations. If you remove a label that has a corresponding translation, you must also remove the label from the translations file.
** Checks for incompatible translations. If you add or remove a new parameter from an existing string, you must also remove the label from the translations file.

Expand All @@ -84,7 +84,7 @@ node scripts/i18n_check --fix --include-config ../kibana-extra/myPlugin/.i18nrc.
Kibana relies on several UI frameworks (ReactJS and AngularJS) and
requires localization in different environments (browser and NodeJS).
The internationalization engine is framework agnostic and consumable in
all parts of Kibana (ReactJS, AngularJS and NodeJS).
all parts of Kibana (ReactJS, AngularJS and NodeJS).

To simplify
internationalization in UI frameworks, additional abstractions are
Expand All @@ -110,7 +110,7 @@ export const HELLO_WORLD = i18n.translate('hello.wonderful.world', {
Full details are {repo}tree/6.7/packages/kbn-i18n#vanilla-js[here].

[float]
===== i18n for React
===== i18n for React

To localize strings in React, use either `FormattedMessage` or `i18n.translate`.

Expand All @@ -136,7 +136,7 @@ Full details are {repo}tree/6.7/packages/kbn-i18n#react[here].


[float]
===== i18n for Angular
===== i18n for Angular

AngularJS wrapper has 4 entities: translation `provider`, `service`, `directive` and `filter`. Both the directive and the filter use the translation `service` with i18n engine under the hood.

Expand Down
4 changes: 2 additions & 2 deletions docs/developer/pr-review.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Enhancements are pretty much always going to have extensive unit tests as a base
[float]
=== Product level review

Reviewers are not simply evaluating the code itself, they are also evaluating the quality of the user-facing change in the product. This generally means they need to check out the branch locally and "play around" with it. In addition to the "do we want this change in the product" details from above, the reviewer should be looking for bugs and evaluating how approachable and useful the feature is as implemented. Special attention should be given to error scenarios and edge cases to ensure they are all handled well within the product.
Reviewers are not simply evaluating the code itself, they are also evaluating the quality of the user-facing change in the product. This generally means they need to check out the branch locally and "play around" with it. In addition to the "do we want this change in the product" details, the reviewer should be looking for bugs and evaluating how approachable and useful the feature is as implemented. Special attention should be given to error scenarios and edge cases to ensure they are all handled well within the product.


[float]
Expand Down Expand Up @@ -107,7 +107,7 @@ Conflicting opinions between reviewers and authors happen, and sometimes it is h

Whether or not a bit of feedback is appropriate for a pull request is often dependent on the motivation for giving the feedback in the first place.

_Demanding_ an author make changes based primarily on the mindset of "how would I write this code?" isn't appropriate. The reviewer didn't write the code, and their critical purpose in the review process is not to craft the contribution into a form that is simply whatever they would have written if they had. If a reviewer wants to provide this type of feedback, they should qualify it as a "nit" as mentioned in the nitpicking section above to make it clear that the author can take it or leave it.
_Demanding_ an author make changes based primarily on the mindset of "how would I write this code?" isn't appropriate. The reviewer didn't write the code, and their critical purpose in the review process is not to craft the contribution into a form that is simply whatever they would have written if they had. If a reviewer wants to provide this type of feedback, they should qualify it as a "nit" as mentioned in the nitpicking section to make it clear that the author can take it or leave it.

Inflammatory feedback such as "this is crap" isn't feedback at all. It's both mean and unhelpful, and it is never appropriate.

Expand Down
75 changes: 36 additions & 39 deletions docs/management/rollups/create_and_manage_rollups.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
== Rollup jobs


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
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
data for use in visualizations and reports.

You’ll find *Rollup Jobs* under *Management > Elasticsearch*. With this UI,
You’ll find *Rollup Jobs* under *Management > Elasticsearch*. With this UI,
you can:

* <<create-and-manage-rollup-job, Create a rollup job>>
Expand All @@ -17,22 +17,22 @@ you can:
[role="screenshot"]
image::images/management_rollup_list.png[][List of currently active rollup jobs]

Before using this feature, you should be familiar with how rollups work.
{ref}/xpack-rollup.html[Rolling up historical data] is a good source for more detailed information.
Before using this feature, you should be familiar with how rollups work.
{ref}/xpack-rollup.html[Rolling up historical data] is a good source for more detailed information.

[float]
[[create-and-manage-rollup-job]]
=== Create a rollup job

{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.
{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.

When defining the index pattern, you must enter a name that is different than
the output rollup index. Otherwise, the job
will attempt to capture the data in the rollup index. For example, if your index pattern is `metricbeat-*`,
you can name your rollup index `rollup-metricbeat`, but not `metricbeat-rollup`.
When defining the index pattern, you must enter a name that is different than
the output rollup index. Otherwise, the job
will attempt to capture the data in the rollup index. For example, if your index pattern is `metricbeat-*`,
you can name your rollup index `rollup-metricbeat`, but not `metricbeat-rollup`.

[role="screenshot"]
image::images/management_create_rollup_job.png[][Wizard that walks you through creation of a rollup job]
Expand All @@ -41,38 +41,38 @@ image::images/management_create_rollup_job.png[][Wizard that walks you through c
[[manage-rollup-job]]
=== Start, stop, and delete rollup jobs

Once you’ve saved a rollup job, you’ll see it the *Rollup Jobs* overview page,
where you can drill down for further investigation. The *Manage* menu in
Once you’ve saved a rollup job, you’ll see it the *Rollup Jobs* overview page,
where you can drill down for further investigation. The *Manage* menu in
the lower right enables you to start, stop, and delete the rollup job.
You must first stop a rollup job before deleting it.

[role="screenshot"]
image::images/management_rollup_job_details.png[][Rollup job details]

You can’t change a rollup job after you’ve created it. To select additional fields
or redefine terms, you must delete the existing job, and then create a new one
with the updated specifications. Be sure to use a different name for the new rollup
job&mdash;reusing the same name can lead to problems with mismatched job configurations.
You can read more at {ref}/rollup-job-config.html[rollup job configuration].
You can’t change a rollup job after you’ve created it. To select additional fields
or redefine terms, you must delete the existing job, and then create a new one
with the updated specifications. Be sure to use a different name for the new rollup
job&mdash;reusing the same name can lead to problems with mismatched job configurations.
You can read more at {ref}/rollup-job-config.html[rollup job configuration].

[float]
=== Try it: Create and visualize rolled up data

This example creates a rollup job to capture log data from sample web logs.
This example creates a rollup job to capture log data from sample web logs.
To follow along, add the <<add-sample-data, sample web logs data set>>.

In this example, you want data that is older than 7 days in the target index pattern `kibana_sample_data_logs`
to roll up once a day into the index `rollup_logstash`. You’ll bucket the
rolled up data on an hourly basis, using 60m for the time bucket configuration.
to roll up once a day into the index `rollup_logstash`. You’ll bucket the
rolled up data on an hourly basis, using 60m for the time bucket configuration.
This allows for more granular queries, such as 2h and 12h.

[float]
==== Create the rollup job

As you walk through the *Create rollup job* UI, enter the data shown in
the table below. The terms, histogram, and metrics fields reflect
the key information to retain in the rolled up data: where visitors are from (geo.src),
what operating system they are using (machine.os.keyword),
As you walk through the *Create rollup job* UI, enter the data shown in
the table below. The terms, histogram, and metrics fields reflect
the key information to retain in the rolled up data: where visitors are from (geo.src),
what operating system they are using (machine.os.keyword),
and how much data is being sent (bytes).

|===
Expand Down Expand Up @@ -118,31 +118,28 @@ and how much data is being sent (bytes).
|===


You can now use the rolled up data for analysis at a fraction of the storage cost
of the original index. The original data can live side by side with the new
You can now use the rolled up data for analysis at a fraction of the storage cost
of the original index. The original data can live side by side with the new
rollup index, or you can remove or archive it using <<creating-index-lifecycle-policies,Index Lifecycle Management>>.

[float]
==== Visualize the rolled up data

Your next step is to visualize your rolled up data in a vertical bar chart.
Your next step is to visualize your rolled up data in a vertical bar chart.
Most visualizations support rolled up data, with the exception of Timelion, TSVB, and Vega visualizations.

Using the information from the example rollup configuration described above,
you can use `rollup_logstash` to match the rolled up index pattern,
and `kibana_sample_data_logs` to match the index pattern for raw data.
The notation for a combination index pattern with both raw and rolled up data
Using the information from the example rollup configuration,
you can use `rollup_logstash` to match the rolled up index pattern,
and `kibana_sample_data_logs` to match the index pattern for raw data.
The notation for a combination index pattern with both raw and rolled up data
is `rollup_logstash,kibana_sample_data_logs`.

[role="screenshot"]
image::images/management_rollup_job_vis.png[][Visualization of rolled up data]

You can then create a dashboard that contains visualizations of the rolled up
You can then create a dashboard that contains visualizations of the rolled up
data, raw data, or both. See <<visualize-rollup-data, Using rolled up data in a visualization>>
for more information.

[role="screenshot"]
image::images/management_rollup_job_dashboard.png[][Dashboard with rolled up data]



Loading

0 comments on commit e70cc73

Please sign in to comment.