Skip to content

Commit

Permalink
[8.x] [Docs] Update nav instructions and sample data installation to …
Browse files Browse the repository at this point in the history
…accommodate for the solution views (elastic#199163) (elastic#199438)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Docs] Update nav instructions and sample data installation to
accommodate for the solution views
(elastic#199163)](elastic#199163)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"florent-leborgne","email":"florent.leborgne@elastic.co"},"sourceCommit":{"committedDate":"2024-11-08T10:10:32Z","message":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution views (elastic#199163)\n\nThis PR:\r\n- updates navigation
instructions to accommodate for the navigation\r\nchanges related to
solution views.\r\n- updates instructions for adding sample data to rely
on the\r\nintegrations page instead of the home page, that only exists
with the\r\nclassic solution view\r\n- updates references to the home
page to avoid confusing users using one\r\nof the new solution
views\r\n\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/529\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/540","sha":"8e7fb7a77e2399e3e946bbba0462517fd7dad0f7","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","v8.16.0","backport:version","v8.17.0"],"title":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution
views","number":199163,"url":"https://github.com/elastic/kibana/pull/199163","mergeCommit":{"message":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution views (elastic#199163)\n\nThis PR:\r\n- updates navigation
instructions to accommodate for the navigation\r\nchanges related to
solution views.\r\n- updates instructions for adding sample data to rely
on the\r\nintegrations page instead of the home page, that only exists
with the\r\nclassic solution view\r\n- updates references to the home
page to avoid confusing users using one\r\nof the new solution
views\r\n\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/529\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/540","sha":"8e7fb7a77e2399e3e946bbba0462517fd7dad0f7"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199163","number":199163,"mergeCommit":{"message":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution views (elastic#199163)\n\nThis PR:\r\n- updates navigation
instructions to accommodate for the navigation\r\nchanges related to
solution views.\r\n- updates instructions for adding sample data to rely
on the\r\nintegrations page instead of the home page, that only exists
with the\r\nclassic solution view\r\n- updates references to the home
page to avoid confusing users using one\r\nof the new solution
views\r\n\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/529\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/540","sha":"8e7fb7a77e2399e3e946bbba0462517fd7dad0f7"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
  • Loading branch information
kibanamachine and florent-leborgne authored Nov 8, 2024
1 parent a651e6d commit 418281b
Show file tree
Hide file tree
Showing 56 changed files with 153 additions and 152 deletions.
10 changes: 3 additions & 7 deletions docs/canvas/canvas-tutorial.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,11 @@ To familiarize yourself with *Canvas*, add the Sample eCommerce orders data, the

To create a workpad of the eCommerce store data, add the data set, then create the workpad.

. On the home page, click *Try sample data*.
. <<gs-get-data-into-kibana,Install the eCommerce sample data>>.

. Click *Other sample data sets*.
. Go to **Canvas** using the navigation menu or the <<kibana-navigation-search,global search field>>.

. On the *Sample eCommerce orders* card, click *Add data*.

. Open the main menu, then click *Canvas*.

. On the *Canvas workpads* page, click *Create workpad*.
. Select *Create workpad*.

[float]
=== Customize your workpad with images
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/data-views.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ and field popularity data. Deleting a {data-source} does not remove any indices

WARNING: Deleting a {data-source} breaks all visualizations, saved searches, and other saved objects that reference the data view.

. Open the main menu, and then click *Stack Management > Data Views*.
. Go to the **Data Views** management page using the navigation menu or the <<kibana-navigation-search,global search field>>.

. Find the {data-source} that you want to delete, and then
click image:management/index-patterns/images/delete.png[Delete icon] in the *Actions* column.
Expand Down
3 changes: 2 additions & 1 deletion docs/dev-tools/grokdebugger/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ is automatically enabled in {kib}.
NOTE: If you're using {stack-security-features}, you must have the `manage_pipeline`
permission to use the Grok Debugger.

. Open the main menu, click *Dev Tools*, then click *Grok Debugger*.
. Find the *Grok Debugger* by navigating to the *Developer tools* page using the
navigation menu or the <<kibana-navigation-search,global search field>>.
. In *Sample Data*, enter a message that is representative of the data that you
want to parse. For example:
+
Expand Down
3 changes: 2 additions & 1 deletion docs/dev-tools/painlesslab/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ process {ref}/docs-reindex.html[reindexed data], define complex
<<watcher-create-advanced-watch, Watcher conditions>>,
and work with data in other contexts.

To get started, open the main menu, click *Dev Tools*, and then click *Painless Lab*.
Find *Painless Lab* by navigating to the *Developer tools* page using the
navigation menu or the <<kibana-navigation-search,global search field>>.

[role="screenshot"]
image::dev-tools/painlesslab/images/painless-lab.png[Painless Lab]
5 changes: 2 additions & 3 deletions docs/dev-tools/searchprofiler/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@ poorly performing queries much faster.
[[search-profiler-getting-started]]
=== Get started

*{searchprofiler}* is automatically enabled in {kib}. Open the main menu,
click *Dev Tools*, and then click *{searchprofiler}*
to get started.
. Find the *{searchprofiler}* by navigating to the *Developer tools* page using the
navigation menu or the <<kibana-navigation-search,global search field>>.

*{searchprofiler}* displays the names of the indices searched, the shards in each index,
and how long it took for the query to complete. To try it out, replace the default `match_all` query
Expand Down
4 changes: 2 additions & 2 deletions docs/developer/getting-started/sample-data.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ There are a couple ways to easily get data ingested into {es}.

The easiest is to install one or more of our available sample data packages. If you have no data, you should be
prompted to install when running {kib} for the first time. You can also access and install the sample data packages
by going to the home page and clicking "add sample data".
by going to the **Integrations** page and selecting **Sample data**.

[discrete]
=== makelogs script
Expand All @@ -27,5 +27,5 @@ Make sure to execute `node scripts/makelogs` *after* {es} is up and running!
[discrete]
=== CSV upload

You can also use the CSV uploader provided on the {kib} home page.
You can also use the CSV uploader provided on the **Upload file** page available in the list of **Integrations**.
Navigate to **Add data** > **Upload file** to upload your data from a file.
2 changes: 1 addition & 1 deletion docs/discover/field-statistics.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ for the data and its cardinality?
This example explores the fields in
the <<gs-get-data-into-kibana, sample web logs data>>, or you can use your own data.

. Open the main menu, and click *Discover*.
. Go to *Discover*.

. Expand the {data-source} dropdown, and select *Kibana Sample Data Logs*.

Expand Down
2 changes: 1 addition & 1 deletion docs/discover/log-pattern-analysis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Log pattern analysis works on every text field.
This example uses the <<gs-get-data-into-kibana, sample web logs data>>, or you
can use your own data.

. Open the main menu, and click *Discover*.
. Go to *Discover*.

. Expand the {data-source} dropdown, and select *Kibana Sample Data Logs*.

Expand Down
2 changes: 1 addition & 1 deletion docs/discover/save-search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ used for the saved search is also automatically selected.
[float]
=== Add search results to a dashboard

. Open the main menu, and then click *Dashboard*.
. Go to *Dashboards*.
. Open or create the dashboard, then click *Edit*.
. Click *Add from library*.
. From the *Types* dropdown, select *Saved search*.
Expand Down
4 changes: 2 additions & 2 deletions docs/discover/search-sessions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ image::images/search-session-awhile.png[Search Session indicator displaying the
Once you save a search session, you can start a new search,
navigate to a different application, or close the browser.

. To view your saved searches, open the main menu, and then click
*Stack Management > Search Sessions*.
. To view your saved searches, go to the
*Search Sessions* management page using the navigation menu or the <<kibana-navigation-search,global search field>>.
For a saved or completed session, you can also open this view from the search sessions popup.

+
Expand Down
3 changes: 1 addition & 2 deletions docs/discover/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,7 @@ To save the current search:
. Click *Save* in the toolbar.
. Enter a name for the search and click *Save*.

To import, export, and delete saved searches, open the main menu,
then click *Stack Management > Saved Objects*.
To import, export, and delete saved searches, go to the *Saved Objects* management page using the navigation menu or the <<kibana-navigation-search,global search field>>.

==== Open a saved search
To load a saved search into Discover:
Expand Down
6 changes: 2 additions & 4 deletions docs/discover/try-esql.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,8 @@ To view the {esql} option in **Discover**, the `enableESQL` setting must be enab

To load the sample data:

. On the home page, click **Try sample data**.
. Click **Other sample data sets**.
. On the Sample web logs card, click **Add data**.
. Open the main menu and select *Discover*.
. <<gs-get-data-into-kibana,Install the web logs sample data>>.
. Go to *Discover*.
. Select *Try {esql}* from the application menu bar.

Let's say we want to find out what operating system users have and how much RAM is on their machine.
Expand Down
2 changes: 1 addition & 1 deletion docs/fleet/fleet.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You can make a complete clone of a whole managed dashboard. If you clone a panel

To clone a dashboard:

. Open the main menu (&#8801;) and click *Dashboards*.
. Go to *Dashboards*.
. Click on the name of the managed dashboard to view the dashboard.
. Click *Clone* in the toolbar.
. Click *Save and return* after editing the dashboard.
Expand Down
19 changes: 10 additions & 9 deletions docs/getting-started/quick-start-guide.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,27 @@ include::{docs-root}/shared/cloud/ess-getting-started.asciidoc[]

[float]
[[gs-get-data-into-kibana]]
== Add the sample data
== Add sample data

Sample data sets come with sample visualizations, dashboards, and more to help you explore {kib} before you ingest or add your own data.

. On the home page, click *Try sample data*.
. Open the **Integrations** page from the navigation menu or using the <<kibana-navigation-search,global search field>>.

. Click *Other sample data sets*.
. In the list of integrations, select **Sample Data**.

. On the *Sample eCommerce orders* card, click *Add data*.
+
[role="screenshot"]
image::images/addData_sampleDataCards_8.6.0.png[Add data UI for the sample data sets]
. On the page that opens, select *Other sample data sets*.

. Install the sample data sets that you want.

Once installed, you can access the sample data in the various {kib} apps available to you.

[float]
[[explore-the-data]]
== Explore the data

*Discover* displays the data in an interactive histogram that shows the distribution of data, or documents, over time, and a table that lists the fields for each document that matches the {data-source}. To view a subset of the documents, you can apply filters to the data, and customize the table to display only the fields you want to explore.

. Open the main menu, then click *Discover*.
. Go to *Discover*.

. Change the <<set-time-filter, time filter>> to *Last 7 days*.
+
Expand All @@ -67,7 +68,7 @@ image::images/availableFields_discover_8.4.0.png[Discover table that displays on

A dashboard is a collection of panels that you can use to visualize the data. Panels contain visualizations, interactive controls, text, and more.

. Open the main menu, then click *Dashboard*.
. Go to *Dashboards*.

. Click *[eCommerce] Revenue Dashboard*.
+
Expand Down
6 changes: 3 additions & 3 deletions docs/management/advanced-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ indicator is displayed:
[role="screenshot"]
image::images/settings-read-only-badge.png[Example of Advanced Settings Management's read only access indicator in Kibana's header]

To add the privilege, open the main menu, then click *Stack Management > Roles*.
To add the privilege, go to the *Roles* management page using the navigation menu or the <<kibana-navigation-search,global search field>>.

For more information on granting access to {kib}, refer to <<xpack-security-authorization>>.

Expand All @@ -30,7 +30,7 @@ For more information on granting access to {kib}, refer to <<xpack-security-auth

Change the settings that apply only to {kib} spaces.

. Open the main menu, then click *Stack Management > Advanced Settings*.
. Go to the *Advanced settings* page using the navigation menu or the <<kibana-navigation-search,global search field>>.
. Click *Space Settings*.
. Scroll or search for the setting.
. Make your change, then click *Save changes*.
Expand Down Expand Up @@ -644,7 +644,7 @@ Disable this option if you prefer to use the new heatmap charts with improved pe

Change the settings that apply only to {kib} spaces.

. Open the main menu, then click *Stack Management > Advanced Settings*.
. Go to the *Advanced settings* page using the navigation menu or the <<kibana-navigation-search,global search field>>.
. Click *Global Settings*.
. Scroll or search for the setting.
. Make your change, then click *Save changes*.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,8 @@ IMPORTANT: Deprecated connectors will continue to function with the rules they w

To update a deprecated connector:

. Open the main menu and go to *{stack-manage-app} > {connectors-ui}*.
. Go to the *{connectors-ui}* page using the navigation menu or the
<<kibana-navigation-search,global search field>>.
. Select the deprecated connector to open the *Edit connector* flyout.
. In the warning message, click *Update this connector*.
. Complete the guided steps in the *Edit connector* flyout.
Expand Down
3 changes: 2 additions & 1 deletion docs/management/connectors/action-types/servicenow.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -338,7 +338,8 @@ IMPORTANT: Deprecated connectors will continue to function with the rules they w

To update a deprecated connector:

. Open the main menu and go to *{stack-manage-app} > {connectors-ui}*.
. Go to the *{connectors-ui}* page using the navigation menu or the
<<kibana-navigation-search,global search field>>.
. Select the deprecated connector to open the *Edit connector* flyout.
. In the warning message, click *Update this connector*.
. Complete the guided steps in the *Edit connector* flyout.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ Sensitive properties, such as passwords, can also be stored in the
[[managing-preconfigured-connectors]]
=== View preconfigured connectors

When you open the main menu, click *{stack-manage-app} > {connectors-ui}*.
go to the *{connectors-ui}* page using the navigation menu or the
<<kibana-navigation-search,global search field>>.
Preconfigured connectors appear regardless of which space you are in.
They are tagged as “preconfigured”, and you cannot delete them.

Expand Down
10 changes: 5 additions & 5 deletions docs/management/manage-data-views.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ then define the field values by emitting a single value using
the {ref}/modules-scripting-painless.html[Painless scripting language].
You can also add runtime fields in <<add-field-in-discover,*Discover*>> and <<change-the-fields,*Lens*>>.

. Open the main menu, then click *Stack Management > Data Views*.
. Go to the *Data Views* management page using the navigation menu or the <<kibana-navigation-search,global search field>>.

. Select the data view that you want to add the runtime field to, then click *Add field*.

Expand Down Expand Up @@ -162,7 +162,7 @@ else {

Edit the settings for runtime fields, or remove runtime fields from data views.

. Open the main menu, then click *Stack Management > Data Views*.
. Go to the *Data Views* management page using the navigation menu or the <<kibana-navigation-search,global search field>>.

. Select the data view that contains the runtime field you want to manage, then open the runtime field edit options or delete the runtime field.

Expand Down Expand Up @@ -198,7 +198,7 @@ https://www.elastic.co/blog/using-painless-kibana-scripted-fields[Using Painless

Create and add scripted fields to your data views.

. Open the main menu, then click *Stack Management > Data Views*.
. Go to the *Data Views* management page using the navigation menu or the <<kibana-navigation-search,global search field>>.

. Select the data view you want to add a scripted field to.

Expand All @@ -214,7 +214,7 @@ For more information about scripted fields in {es}, refer to {ref}/modules-scrip
[[update-scripted-field]]
==== Manage scripted fields

. Open the main menu, then click *Stack Management > Data Views*.
. Go to the *Data Views* management page using the navigation menu or the <<kibana-navigation-search,global search field>>.

. Select the data view that contains the scripted field you want to manage.

Expand All @@ -230,7 +230,7 @@ exceptions when you view the dynamically generated data.
{kib} uses the same field types as {es}, however, some {es} field types are unsupported in {kib}.
To customize how {kib} displays data fields, use the formatting options.

. Open the main menu, then click *Stack Management > Data Views*.
. Go to the *Data Views* management page using the navigation menu or the <<kibana-navigation-search,global search field>>.

. Click the data view that contains the field you want to change.

Expand Down
6 changes: 4 additions & 2 deletions docs/management/managing-licenses.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,16 @@ If you need more than 30 days to complete your evaluation,
request an extended trial at {extendtrial}.

To view the status of your license, start a trial, or install a new
license, open the main menu, then click *Stack Management > License Management*.
license, go to the *License Management* page using the navigation menu or the
<<kibana-navigation-search,global search field>>.

[discrete]
=== Required permissions

The `manage` cluster privilege is required to access *License Management*.

To add the privilege, open the main menu, then click *Stack Management > Roles*.
To add the privilege, go to the *Roles* management page using the navigation menu or the
<<kibana-navigation-search,global search field>>.

[discrete]
[[license-expiration]]
Expand Down
6 changes: 4 additions & 2 deletions docs/management/managing-saved-objects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
Edit, import, export, and copy your saved objects. These objects include
dashboards, visualizations, maps, {data-sources}, *Canvas* workpads, and other saved objects.

To get started, open the main menu, and then click *Stack Management > Saved Objects*.
You can find the *Saved Objects* page using the navigation menu or the
<<kibana-navigation-search,global search field>>.

[role="screenshot"]
image::images/management-saved-objects.png[Saved Objects]
Expand All @@ -14,7 +15,8 @@ image::images/management-saved-objects.png[Saved Objects]

To access *Saved Objects*, you must have the required `Saved Objects Management` {kib} privilege.

To add the privilege, open the main menu, and then click *Stack Management > Roles*.
To add the privilege, go to the *Roles* management page using the navigation menu or the
<<kibana-navigation-search,global search field>>.

NOTE: Granting access to `Saved Objects Management` authorizes users to
manage all saved objects in {kib}, including objects that are managed by
Expand Down
7 changes: 4 additions & 3 deletions docs/management/managing-tags.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
Use tags to categorize your saved objects,
then filter for related objects based on shared tags.

To get started, open the main menu, and then click *Stack Management > Tags*.
To get started, go to the *Tags* management page using the navigation menu or the
<<kibana-navigation-search,global search field>>.

[role="screenshot"]
image::images/tags/tag-management-section.png[Tags management]
Expand All @@ -15,8 +16,8 @@ image::images/tags/tag-management-section.png[Tags management]

To create tags, you must meet the minimum requirements.

* Access to *Tags* requires the `Tag Management` Kibana privilege. To add the privilege, open the main menu,
and then click *Stack Management > Roles*.
* Access to *Tags* requires the `Tag Management` Kibana privilege. To add the privilege, go to the *Roles* page using the navigation menu or the
<<kibana-navigation-search,global search field>>.
* The `read` privilege allows you to assign tags to the saved objects for which you have write permission.
* The `write` privilege enables you to create, edit, and delete tags.

Expand Down
11 changes: 7 additions & 4 deletions docs/management/rollups/create_and_manage_rollups.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ an index pattern, and then 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.

To get started, open the main menu, then click *Stack Management > Rollup Jobs*.
You can go to the *Rollup Jobs* page using the navigation menu or the
<<kibana-navigation-search,global search field>>.

[role="screenshot"]
image::images/management_rollup_list.png[List of currently active rollup jobs]
Expand All @@ -23,7 +24,8 @@ detailed information.

The `manage_rollup` cluster privilege is required to access *Rollup jobs*.

To add the privilege, open the main menu, then click *Stack Management > Roles*.
To add the privilege, go to the *Roles* management page using the navigation menu or the
<<kibana-navigation-search,global search field>>.

[float]
[[create-and-manage-rollup-job]]
Expand Down Expand Up @@ -142,7 +144,8 @@ rollup index, or you can remove or archive it using
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 and Vega visualizations.

. Open the main menu, then click *Stack Management > Data Views*.
. Go to the *Data Views* page using the navigation menu or the
<<kibana-navigation-search,global search field>>.

. Click *Create data view*, and select *Rollup data view* from the dropdown.

Expand All @@ -153,7 +156,7 @@ The notation for a combination data view with both raw and rolled up data is
`rollup_logstash,kibana_sample_data_logs`. In this data view, `rollup_logstash`
matches the rollup index and `kibana_sample_data_logs` matches the raw data.

. Open the main menu, click *Dashboard*, then *Create dashboard*.
. Go to *Dashboards*, then select *Create dashboard*.

. Set the <<set-time-filter,time filter>> to *Last 90 days*.

Expand Down
Loading

0 comments on commit 418281b

Please sign in to comment.