elastic / elastic/docs-content

[Website]: Replace supported deployment methods badges

Open
#1,823 0 comments 1 reaction 0 assignees View on GitHub
source:web Team:Ingest
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 12h
Merged PRs (30d)
116

Description

### What documentation page is affected

The `docs-content` repo contains 21 instances of `![supported deployment methods]` across 19 files:

21 results - 19 files

```
solutions/observability/apm/apm-agent-authorization.md:
13 ::::{note}
14: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-yes.svg "")
15

93 ::::{note}
94: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
95

solutions/observability/apm/configure-anonymous-authentication.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-yes.svg "")
16

solutions/observability/apm/configure-apm-agent-central-configuration.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-yes.svg "")
16

solutions/observability/apm/configure-apm-instrumentation.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
16

solutions/observability/apm/configure-console-output.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
16

solutions/observability/apm/configure-elasticsearch-output.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
16

solutions/observability/apm/configure-kafka-output.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
16

solutions/observability/apm/configure-kibana-endpoint.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
16

solutions/observability/apm/configure-logging.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
16

solutions/observability/apm/configure-logstash-output.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
16

solutions/observability/apm/configure-output-for-elasticsearch-service-on-elastic-cloud.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
16

solutions/observability/apm/configure-project-paths.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
16

solutions/observability/apm/configure-real-user-monitoring-rum.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-yes.svg "")
16

134 ::::{admonition}
135: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
136

solutions/observability/apm/configure-redis-output.md:
14 ::::{note}
15: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
16

solutions/observability/apm/general-configuration-options.md:
13 ::::{note}
14: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-yes.svg "")
15

solutions/observability/apm/ssl-tls-input-settings.md:
13 ::::{note}
14: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-yes.svg "")
15

solutions/observability/apm/ssl-tls-output-settings.md:
13 ::::{note}
14: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
15

solutions/observability/apm/tail-based-sampling.md:
13 ::::{note}
14: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-yes.svg "")
15

solutions/observability/apm/use-environment-variables-in-configuration.md:
13 ::::{note}
14: ![supported deployment methods](/solutions/images/observability-binary-yes-fm-no.svg "")
15
```

## What happened?

As explained by @bmorelli25, support deployment badges were added to APM docs to...

> A couple years ago when Fleet-managed APM Server was introduced, customers were confused as to which settings applied to Fleet, which applied to the APM Server binary, and which settings applied to both. [...] I think we initially called out the differences in admonitions but folks continued to have problems (as if they weren't reading them). So we added this visual flair.

Here's an example: https://www.elastic.co/docs/solutions/observability/apm/configure-apm-agent-central-configuration

Image

## Solution

We should replace the visual flairs with something that is not a static image. We could possibly use applies_to tags for this, or something else. There's a potential redundancy/conflict of these badges with the new applicability tags that could generate confusion. It's also visually distracting.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.