You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[9.0] [docs] Fix image paths for docs-assembler (#218344) (#218359)
# Backport
This will backport the following commits from `main` to `9.0`:
- [[docs] Fix image paths for docs-assembler
(#218344)](#218344)
<!--- Backport version: 9.6.6 -->
### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)
<!--BACKPORT [{"author":{"name":"Colleen
McGinnis","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-04-15T21:59:57Z","message":"[docs]
Fix image paths for docs-assembler (#218344)\n\nFixes image paths to
work with docs-assembler.\n\nNotes for the reviewer:\n* I was not able
to get images in reference, extend, or release-notes to\nwork using the
`:::{image}` syntax because it seems to resolve\ndifferently than the
Markdown `![]()` syntax. We should address this in\ndocs-builder, but in
order to get images working as soon as possible,\nI've used Markdown
syntax and left us a `TO DO` in a code comment to add\nback the
`screenshot` class where applicable.\n* Can you please add the
appropriate labels needed for
backporting?","sha":"907cd5904b3328d5c89da31fb19c0528a6acdd50","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","documentation","backport:version","v9.1.0","v9.0.1"],"title":"[docs]
Fix image paths for
docs-assembler","number":218344,"url":"https://github.com/elastic/kibana/pull/218344","mergeCommit":{"message":"[docs]
Fix image paths for docs-assembler (#218344)\n\nFixes image paths to
work with docs-assembler.\n\nNotes for the reviewer:\n* I was not able
to get images in reference, extend, or release-notes to\nwork using the
`:::{image}` syntax because it seems to resolve\ndifferently than the
Markdown `![]()` syntax. We should address this in\ndocs-builder, but in
order to get images working as soon as possible,\nI've used Markdown
syntax and left us a `TO DO` in a code comment to add\nback the
`screenshot` class where applicable.\n* Can you please add the
appropriate labels needed for
backporting?","sha":"907cd5904b3328d5c89da31fb19c0528a6acdd50"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/218344","number":218344,"mergeCommit":{"message":"[docs]
Fix image paths for docs-assembler (#218344)\n\nFixes image paths to
work with docs-assembler.\n\nNotes for the reviewer:\n* I was not able
to get images in reference, extend, or release-notes to\nwork using the
`:::{image}` syntax because it seems to resolve\ndifferently than the
Markdown `![]()` syntax. We should address this in\ndocs-builder, but in
order to get images working as soon as possible,\nI've used Markdown
syntax and left us a `TO DO` in a code comment to add\nback the
`screenshot` class where applicable.\n* Can you please add the
appropriate labels needed for
backporting?","sha":"907cd5904b3328d5c89da31fb19c0528a6acdd50"}}]}]
BACKPORT-->
Co-authored-by: Colleen McGinnis <[email protected]>
Copy file name to clipboardExpand all lines: docs/extend/interpreting-ci-failures.md
+4-12Lines changed: 4 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,9 +21,7 @@ Clicking the link next to the check in the conversation tab of a pull request wi
21
21
22
22
To view the results of a job execution in Buildkite, either click the link in the comment left by `@elasticmachine` or search for the `kibana-ci` check in the list at the bottom of the PR. This link will take you to the top-level page for the specific job execution that failed.
23
23
24
-
:::{image} images/job_view.png
25
-
:alt: Buildkite pipeline view showing a few test failures
26
-
:::
24
+
27
25
28
26
1.**Git commit:** the git commit that caused this build.
29
27
2.**Test Results:** A link to the test results screen, and shortcuts to the logs and jobs of the failed tests. Functional tests capture and store the log output from each specific test, and make it visible at these links.
@@ -34,9 +32,7 @@ To view the results of a job execution in Buildkite, either click the link in th
34
32
35
33
The logs in Pipeline Steps contain `Info` level logging. To debug Functional UI tests it’s usually helpful to see the debug logging. You can go to the test failure details by clicking on the **logs** (1).
Looking at the failure, we first look at the Error and stack trace. In the example below, this test failed to find an element within the timeout; `Error: retry.try timeout: TimeoutError: Waiting for element to be located By(css selector, [data-test-subj="createSpace"])`
42
38
@@ -69,15 +65,11 @@ Just above the `✖ fail:` line, there is a line `info Taking screenshot ...` wh
69
65
70
66
Clicking the `[Download]` link for that png shows this image:
71
67
72
-
:::{image} images/a11y_screenshot.png
73
-
:alt: Kibana spaces page meets a11y validations a11y test for click on create space page.png
74
-
:::
68
+
75
69
76
70
If we use a running Kibana instance and inspect elements, we find that the `createSpace` data-test-subj attribute is on this button in the Spaces page in Stack Management:
77
71
78
-
:::{image} images/inspect_element.png
79
-
:alt: Kibana screenshot of Spaces page with developer tools open
80
-
:::
72
+
81
73
82
74
We know the test was not on the correct page to find the element to click. We see in the debug log the repeated attempts to find the element. If we scroll to the start of those repeated attempts, we see that the first thing the test did was this attempt to click on the `createSpace` element.
Copy file name to clipboardExpand all lines: docs/extend/kibana-debugging.md
+2-6Lines changed: 2 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,9 +21,7 @@ With an application as varied and complex as Kibana has become, it’s not pract
21
21
22
22
For example, say you implement a brand new feature, plugin or service but don’t quite know how it will impact Kibana’s performance as a whole. APM allows us to not only spot that something is slow, but also hints at why it might be performing slowly. For example, if a function is slow on specific types of inputs, we can see where the time is spent by viewing the trace for that function call in the APM UI.
23
23
24
-
:::{image} images/apm_example_trace.png
25
-
:alt: apm example trace
26
-
:::
24
+
27
25
28
26
The net of metrics captured by APM are both a wide and deep because the entire application is instrumented at runtime and we simply take a sample of these metrics. This means that we don’t have to know what we need to measure ahead of time, we’ll instead just get (most) of the data we’re likely going to need by default.
29
27
@@ -103,9 +101,7 @@ The easiest and recommended way of running Kibana with the APM agent locally is
103
101
104
102
9. After Kibana starts up, navigate to the APM app, where you should see some transactions.
You can now continue doing what you want to in Kibana (e.g. install sample data sets, issue queries in dashboards, build new visualizations etc). Once you’re finished, you can stop Kibana normally, then stop the {{es}} and APM servers in the apm-integration-testing clone with the following script:
Copy file name to clipboardExpand all lines: docs/extend/sharing-saved-objects.md
+17-51Lines changed: 17 additions & 51 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,7 @@ From 8.7.0, as a step towards *zero downtime upgrades*, plugins are no longer al
13
13
14
14
[Saved objects](/extend/saved-objects-service.md) (hereinafter "objects") are used to store all sorts of things in {{kib}}, from Dashboards to Index Patterns to Machine Learning Jobs. The effort to make objects shareable can be summarized in a single picture:
Each plugin can register different object types to be used in {{kib}}. Historically, objects could be *isolated* (existing in a single [space](docs-content://deploy-manage/manage-spaces.md)) or *global* (existing in all spaces), there was no in-between. As of the 7.12 release, {{kib}} now supports two additional types of objects:
21
19
@@ -57,9 +55,7 @@ External plugins can also convert their objects, but [they don’t have to do so
57
55
58
56
If you’re still reading this page, you’re probably developing a {{kib}} plugin that registers an object type, and you want to know what steps you need to take to prepare for the 8.0 release and mitigate any breaking changes! Depending on how you are using saved objects, you may need to take up to 5 steps, which are detailed in separate sections below. Refer to this flowchart:
There is a proof-of-concept (POC) pull request to demonstrate these changes. It first adds a simple test plugin that allows users to create and view notes. Then, it goes through the steps of the flowchart to convert the isolated "note" objects to become share-capable. As you read this guide, you can [follow along in the POC](https://github.com/elastic/kibana/pull/107256) to see exactly how to take these steps.
@@ -81,9 +77,7 @@ If you answered "Yes" to [Question 1](#sharing-saved-objects-q1), you need to ma
81
77
82
78
The image below shows two different examples of object links from a "case" object to an "action" object. The top shows the incorrect way to link to another object, and the bottom shows the correct way.
If your objects *do not* use the root-level `references` field, you’ll need to [add a migration](/extend/saved-objects-service.md#saved-objects-service-writing-migrations)*before the 8.0 release* to fix that. Here’s a migration function for the example above:
89
83
@@ -124,9 +118,7 @@ Reminder, don’t forget to add unit tests and integration tests!
124
118
[TBC: QUOTE]
125
119
A deep link is a URL to a page that shows a specific object. End-users may bookmark these URLs or schedule reports with them, so it is critical to ensure that these URLs continue working. The image below shows an example of a deep link to a Canvas workpad object:
126
120
127
-
:::{image} images/sharing-saved-objects-q2.png
128
-
:alt: Sharing Saved Objects deep link example
129
-
:::
121
+
130
122
131
123
Note that some URLs may contain [deep links to multiple objects](#sharing-saved-objects-faq-multiple-deep-link-objects), for example, a Dashboard *and* a filter for an Index Pattern.
132
124
@@ -180,9 +172,7 @@ The Spaces plugin API exposes React components and functions that you should use
180
172
181
173
Your page should change [according to the outcome](#sharing-saved-objects-faq-resolve-outcomes):
The [DataViewspage](docs-content://explore-analyze/find-and-organize/data-views.md) in [Stack Management](docs-content://deploy-manage/index.md) uses a [similar approach](https://github.com/elastic/kibana/blob/master/src/platform/plugins/shared/data_view_management/public/components/edit_index_pattern/edit_index_pattern.tsx) to show a warning in its delete confirmation modal:
This outcome can only happen in non-Default spaces.
563
531
564
532
**Outcome 3**
565
533
566
534
The third outcome is an edge case that is a combination of the others. If you resolve an object ID and two objects are found — one as an exact match, the other as an alias match — the outcome is a `'conflict'`:
We actually have controls in place to prevent this scenario from happening when you share, import, or copy objects. However, this scenario *could* still happen in a few different situations, if objects are created a certain way or if a user tampers with an object’s raw ES document. Since we can’t 100% rule out this scenario, we must handle it gracefully, but we do expect this will be a rare occurrence.
Copy file name to clipboardExpand all lines: docs/reference/advanced-settings.md
+2-4Lines changed: 2 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,10 +19,8 @@ The `Advanced Settings` {{kib}} privilege is required to access **Advanced Setti
19
19
20
20
When you have insufficient privileges to edit advanced settings, the edit options are not visible, and the following indicator is displayed:
21
21
22
-
:::{image} images/settings-read-only-badge.png
23
-
:alt: Example of Advanced Settings Management's read only access indicator in Kibana's header
24
-
:class: screenshot
25
-
:::
22
+
% TO DO: Use `:class: screenshot`
23
+
26
24
27
25
To add the privilege, go to the **Roles** management page using the navigation menu or the [global search field](docs-content://get-started/the-stack.md#kibana-navigation-search).
Copy file name to clipboardExpand all lines: docs/reference/connectors-kibana.md
+12-24Lines changed: 12 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,10 +46,8 @@ Some connector types are paid commercial features, while others are free. For a
46
46
47
47
Rules use connectors to route actions to different destinations like log files, ticketing systems, and messaging tools. While each {{kib}} app can offer their own types of rules, they typically share connectors. **{{stack-manage-app}} > {{connectors-ui}}** offers a central place to view and manage all the connectors in the current space.
48
48
49
-
:::{image} images/connector-listing.png
50
-
:alt: Example connector listing in the {{rules-ui}} UI
51
-
:class: screenshot
52
-
:::
49
+
% TO DO: Use `:class: screenshot`
50
+
53
51
54
52
55
53
## Required permissions [_required_permissions_2]
@@ -66,17 +64,13 @@ Use the [action configuration settings](/reference/configuration-reference/alert
66
64
67
65
In **{{stack-manage-app}} > {{connectors-ui}}**, you can find a list of the connectors in the current space. You can use the search bar to find specific connectors by name and type. The **Type** dropdown also enables you to filter to a subset of connector types.
68
66
69
-
:::{image} images/connector-filter-by-type.png
70
-
:alt: Filtering the connector list by types of connectors
71
-
:class: screenshot
72
-
:::
67
+
% TO DO: Use `:class: screenshot`
68
+
73
69
74
70
You can delete individual connectors using the trash icon. Alternatively, select multiple connectors and delete them in bulk using the **Delete** button.
75
71
76
-
:::{image} images/connector-delete.png
77
-
:alt: Deleting connectors individually or in bulk
78
-
:class: screenshot
79
-
:::
72
+
% TO DO: Use `:class: screenshot`
73
+
80
74
81
75
::::{note}
82
76
You can delete a connector even if there are still actions referencing it. When this happens the action will fail to run and errors appear in the {{kib}} logs.
@@ -89,10 +83,8 @@ You can delete a connector even if there are still actions referencing it. When
89
83
90
84
New connectors can be created with the **Create connector** button, which guides you to select the type of connector and configure its properties.
0 commit comments