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 8493ce6 commit ef036d7
Show file tree
Hide file tree
Showing 20 changed files with 117 additions and 184 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.

45 changes: 17 additions & 28 deletions docs/dev-tools/console/console.asciidoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
[[console-kibana]]
== Console

Console enables you to interact with the REST API of {es}. *Note:* You cannot
Console enables you to interact with the REST API of {es}. *Note:* You cannot
interact with {kib} API endpoints via Console.

Go to *Dev Tools > Console* to get started.
Go to *Dev Tools > Console* to get started.

Console has two main areas:
Console has two main areas:

* The *editor*, where you compose requests to send to {es}.
* The *response* pane, which displays the responses to the request.
Expand All @@ -18,8 +18,8 @@ image::dev-tools/console/images/console.png["Console"]
[[console-api]]
=== Writing requests

Console understands commands in a cURL-like syntax.
For example, the following is a `GET` request to the {es} `_search` API.
Console understands commands in a cURL-like syntax.
For example, the following is a `GET` request to the {es} `_search` API.

[source,js]
----------------------------------
Expand All @@ -43,34 +43,31 @@ curl -XGET "http://localhost:9200/_search" -d'
}'
----------------------------------

If you paste the above command into Console, {kib} automatically converts it
to Console syntax. Alternatively, if you want to want to see Console syntax in cURL,
click the action icon (image:dev-tools/console/images/wrench.png[]) and select *Copy as cURL*.
When you paste the command into Console, {kib} automatically converts it
to Console syntax. Alternatively, if you want to want to see Console syntax in cURL,
click the action icon (image:dev-tools/console/images/wrench.png[]) and select *Copy as cURL*.

For help with formatting requests, you can use Console's <<auto-formatting, auto formatting>>
For help with formatting requests, you can use Console's <<auto-formatting, auto formatting>>
feature.

=== Submitting requests

[float]
[[console-request]]
=== Submitting requests

Once you enter a command in the editor, click the
Once you enter a command in the editor, click the
green triangle to submit the request to {es}.

You can select multiple requests and submit them together.
Console sends the requests to {es} one by one and shows the output
in the response pane. Submitting multiple request is helpful when you're debugging an issue or trying query
Console sends the requests to {es} one by one and shows the output
in the response pane. Submitting multiple request is helpful when you're debugging an issue or trying query
combinations in multiple scenarios.

[float]
[[console-autocomplete]]
=== Using autocomplete

When typing a command, Console makes context-sensitive suggestions.
These suggestions can help you explore parameters for each API and speed up typing.
To configure your preferences for autocomplete, go to
<<configuring-console, Settings>>.
These suggestions can help you explore parameters for each API and speed up typing.
To configure your preferences for autocomplete, go to
<<configuring-console, Settings>>.

[float]
[[console-view-api]]
Expand All @@ -84,14 +81,6 @@ the action icon (image:dev-tools/console/images/wrench.png[]) and selecting
[[console-history]]
=== Getting your request history

Console maintains a list of the last 500 requests that {es} successfully executed.
Console maintains a list of the last 500 requests that {es} successfully executed.
To view your most recent requests, click *History*. If you select a request
and click *Apply*, {kib} adds it to the editor at the current cursor position.



include::auto-formatting.asciidoc[]

include::keyboard-shortcuts.asciidoc[]

include::configuring-console.asciidoc[]
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 @@ -175,7 +175,7 @@ init(server) {
}
-----------

Unlike the Canvas example above, Dev Tools does not require access to any saved objects to function. Dev Tools does specify an API endpoint, however. When this is configured, the Security plugin will automatically authorize access to any server API route that is tagged with `access:console`, similar to the following:
Unlike the Canvas example, Dev Tools does not require access to any saved objects to function. Dev Tools does specify an API endpoint, however. When this is configured, the Security plugin will automatically authorize access to any server API route that is tagged with `access:console`, similar to the following:

["source","javascript"]
-----------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,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 @@ -86,7 +86,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 @@ -112,7 +112,7 @@ export const HELLO_WORLD = i18n.translate('hello.wonderful.world', {
Full details are {repo}tree/master/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 @@ -138,7 +138,7 @@ Full details are {repo}tree/master/packages/kbn-i18n#react[here].


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

You are encouraged to use `i18n.translate()` by statically importing `i18n` from `@kbn/i18n` wherever possible in your Angular code. Angular wrappers use the translation `service` with the 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
2 changes: 1 addition & 1 deletion docs/infrastructure/metrics-explorer.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ In this step we'll leave the aggregation dropdown set to *Average* but you can t

4. In the *graph per* dropdown, enter `host.name` and select this field.
You will see a separate graph for each host you are monitoring.
If you are collecting metrics for multiple hosts, you will see something like the screenshot above.
If you are collecting metrics for multiple hosts, multiple graphics are displayed.
If you only have metrics for a single host, you will see a single graph.
Congratulations! Either way, you've explored your first metric.

Expand Down
7 changes: 3 additions & 4 deletions docs/logs/using.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -41,31 +41,30 @@ To quickly jump to a nearby point in time, click on the timeline to the right.
[role="screenshot"]
image::logs/images/logs-usage-timeline.png[Logs timeline]


[float]
[[logs-customize]]
=== Customize your view
Use *Customize* to adjust your console view and to set the time scale of the log data.

* *Text size.* Select `Small`, `Medium`, or `Large`.
* *Wrap long lines.* Enable or disable line wrap.
* *Minimap Scale.* Set the scale to 'year', 'month', 'week', 'day', 'hour', or 'minute'.
* *Minimap Scale.* Set the scale to 'year', 'month', 'week', 'day', 'hour', or 'minute'.

[role="screenshot"]
image::logs/images/logs-usage-customize.png[Logs view customization popover]

[float]
[[logs-stream]]
=== Stream or pause logs
You can stream data for live log tailing, or pause streaming to focus on historical log data.
You can stream data for live log tailing, or pause streaming to focus on historical log data.

[role="screenshot"]
image::logs/images/logs-usage-start-streaming.png[Logs start streaming]

[role="screenshot"]
image::logs/images/logs-usage-stop-streaming.png[Logs stop streaming]

When you are streaming logs, the most recent log appears at the bottom on the console.
When you are streaming logs, the most recent log appears at the bottom on the console.

[role="screenshot"]
image::logs/images/logs-usage-streaming-indicator.png[Logs streaming indicator]
Expand Down
Loading

0 comments on commit ef036d7

Please sign in to comment.