Skip to content

[docs] Miscellaneous docs clean up #13182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
469 changes: 0 additions & 469 deletions docs/docset.yml

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/extend/dashboard-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ Keep the following guidelines in mind when positioning your elements on dashboar

* Keep related visualizations close to each other.

:::{image} ../images/grouping-in-visualizations.png
:::{image} images/grouping-in-visualizations.png
:alt: Closely grouped visualizations
:::

* Use Markdown to create blocks of related content.

:::{image} ../images/markdown-grouping.png
:::{image} images/markdown-grouping.png
:alt: Markdown grouping in visualizations
:::

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

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.

:::{image} ../images/rows-in-visualizations.png
:::{image} images/rows-in-visualizations.png
:alt: Central focal point in visualization
:::

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

Example:

:::{image} ../images/filter-in-visualization.png
:::{image} images/filter-in-visualization.png
:alt: Filter in a visualization
:::

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

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.

:::{image} ../images/colors-in-visualizations.png
:::{image} images/colors-in-visualizations.png
:alt: Colors in visualizations
:::

Expand All @@ -154,6 +154,6 @@ Titles can have a strong visual impact on dashboards, especially when there are
* Remove unnecessary or repetitive titles when the information is already explained or written within the chart.
* 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.

:::{image} ../images/titles-in-visualizations.png
:::{image} images/titles-in-visualizations.png
:alt: Titles in visualizations
:::
8 changes: 4 additions & 4 deletions docs/extend/developer-workflow-support-old-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Follow these detailed steps to release a fix for a given package version:
* Look for the merge commit of the PR

* [https://github.com/elastic/integrations/commit/aa63e1f6a61d2a017e1f88af2735db129cc68e0c](https://github.com/elastic/integrations/commit/aa63e1f6a61d2a017e1f88af2735db129cc68e0c)
* It can be found as one of the last messages in the PR ![merged commit](../images/merge_commit_message.png "")
* It can be found as one of the last messages in the PR ![merged commit](images/merge_commit_message.png "")
* And then show the previous commits for that changeset inside the package folder (e.g. `packages/aws`):
* [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 "")
* [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 "")

* Using the command line:

Expand Down Expand Up @@ -55,11 +55,11 @@ Follow these detailed steps to release a fix for a given package version:
Move lightweight manifest to integration for EBS data stream (#3856)
```

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 "")
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 "")

**Please, pay attention!**, if you just run the pipeline it’ll wait for your inputs, nothing will happen without that.

:::{image} ../images/backport_input_step.png
:::{image} images/backport_input_step.png
:alt: waiting input step
:::

Expand Down
File renamed without changes
4 changes: 2 additions & 2 deletions docs/extend/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ You’ll need to have a few requirements in place to run this tutorial:

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

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

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

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

Expand Down