Skip to content

Commit 6167231

Browse files
colleenmcginnisflexitrev
authored andcommitted
[docs] Miscellaneous docs clean up (#13182)
* remove unused substitutions * move images
1 parent 166a032 commit 6167231

16 files changed

+12
-481
lines changed

docs/docset.yml

Lines changed: 0 additions & 469 deletions
Large diffs are not rendered by default.

docs/extend/dashboard-guidelines.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,13 @@ Keep the following guidelines in mind when positioning your elements on dashboar
6666

6767
* Keep related visualizations close to each other.
6868

69-
:::{image} ../images/grouping-in-visualizations.png
69+
:::{image} images/grouping-in-visualizations.png
7070
:alt: Closely grouped visualizations
7171
:::
7272

7373
* Use Markdown to create blocks of related content.
7474

75-
:::{image} ../images/markdown-grouping.png
75+
:::{image} images/markdown-grouping.png
7676
:alt: Markdown grouping in visualizations
7777
:::
7878

@@ -84,7 +84,7 @@ Keep the following guidelines in mind when positioning your elements on dashboar
8484

8585
Placing a big chart at the center of a dashboard, especially one with prominent visual shapes such as rectangles, helps to reinforce a natural visual focal point that lies in the center of the interface.
8686

87-
:::{image} ../images/rows-in-visualizations.png
87+
:::{image} images/rows-in-visualizations.png
8888
:alt: Central focal point in visualization
8989
:::
9090

@@ -117,7 +117,7 @@ As much as possible, avoid using general filters, that is filters with `-*`. Co
117117

118118
Example:
119119

120-
:::{image} ../images/filter-in-visualization.png
120+
:::{image} images/filter-in-visualization.png
121121
:alt: Filter in a visualization
122122
:::
123123

@@ -142,7 +142,7 @@ Use color to distinguish categories, represent quantity/density, and highlight d
142142

143143
If your dashboard is made to identify specific behaviors, it might be interesting to consider a color setting that could help to point those out. Use a neutral color for generic elements and an accented color for the things that you want to highlight.
144144

145-
:::{image} ../images/colors-in-visualizations.png
145+
:::{image} images/colors-in-visualizations.png
146146
:alt: Colors in visualizations
147147
:::
148148

@@ -154,6 +154,6 @@ Titles can have a strong visual impact on dashboards, especially when there are
154154
* Remove unnecessary or repetitive titles when the information is already explained or written within the chart.
155155
* When a title is needed, make it self explanatory and exhaustive. This way, you will be able to remove axis titles and other specifications leaving more space for the chart itself.
156156

157-
:::{image} ../images/titles-in-visualizations.png
157+
:::{image} images/titles-in-visualizations.png
158158
:alt: Titles in visualizations
159159
:::

docs/extend/developer-workflow-support-old-package.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Follow these detailed steps to release a fix for a given package version:
1818
* Look for the merge commit of the PR
1919

2020
* [https://github.com/elastic/integrations/commit/aa63e1f6a61d2a017e1f88af2735db129cc68e0c](https://github.com/elastic/integrations/commit/aa63e1f6a61d2a017e1f88af2735db129cc68e0c)
21-
* It can be found as one of the last messages in the PR ![merged commit](../images/merge_commit_message.png "")
21+
* It can be found as one of the last messages in the PR ![merged commit](images/merge_commit_message.png "")
2222
* And then show the previous commits for that changeset inside the package folder (e.g. `packages/aws`):
23-
* [https://github.com/elastic/integrations/commits/aa63e1f6a61d2a017e1f88af2735db129cc68e0c/packages/aws/](https://github.com/elastic/integrations/commits/aa63e1f6a61d2a017e1f88af2735db129cc68e0c/packages/aws/) ![commits from package](../images/browse_package_commits.png "")
23+
* [https://github.com/elastic/integrations/commits/aa63e1f6a61d2a017e1f88af2735db129cc68e0c/packages/aws/](https://github.com/elastic/integrations/commits/aa63e1f6a61d2a017e1f88af2735db129cc68e0c/packages/aws/) ![commits from package](images/browse_package_commits.png "")
2424

2525
* Using the command line:
2626

@@ -55,11 +55,11 @@ Follow these detailed steps to release a fix for a given package version:
5555
Move lightweight manifest to integration for EBS data stream (#3856)
5656
```
5757
58-
2. Run the **integrations-backport** pipeline [https://buildkite.com/elastic/integrations-backport](https://buildkite.com/elastic/integrations-backport) for creating the backport branch. ![buildkite buid](../images/build.png "")
58+
2. Run the **integrations-backport** pipeline [https://buildkite.com/elastic/integrations-backport](https://buildkite.com/elastic/integrations-backport) for creating the backport branch. ![buildkite buid](images/build.png "")
5959
6060
**Please, pay attention!**, if you just run the pipeline it’ll wait for your inputs, nothing will happen without that.
6161
62-
:::{image} ../images/backport_input_step.png
62+
:::{image} images/backport_input_step.png
6363
:alt: waiting input step
6464
:::
6565
File renamed without changes.

docs/extend/quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ You’ll need to have a few requirements in place to run this tutorial:
114114

115115
3. After the command runs, check that your new package appears in Kibana under **Management > Integrations > Installed integrations**.
116116

117-
:::{image} ../images/package-installed.png
117+
:::{image} images/package-installed.png
118118
:alt: Kibana installed integrations tab with a card for my sample package
119119
:::
120120

@@ -417,7 +417,7 @@ To run these steps using {{fleet}}-managed {{agent}}, you just need to update th
417417
2. In the search field, enter `log.file.path.text : *`. The search should return a couple of log entries.
418418
3. Hover over an entry and click `Enter` to view the cell contents.
419419

420-
:::{image} ../images/datastream-log-message.png
420+
:::{image} images/datastream-log-message.png
421421
:alt: Data stream showing log message: "this is a nice day"
422422
:::
423423

0 commit comments

Comments
 (0)