-
Notifications
You must be signed in to change notification settings - Fork 190
Description
When PR elastic/docs-builder#2322 is merged, we’ll need to manually adjust some applies_to tags for the new syntax and semantics.
When we do the cleanup, we should review:
| Use case | Example | Action |
|---|---|---|
| Different UI/options/settings available in different minor versions | Example #1 Example #2 |
Replace the tag for the earlier functionality with an exact version or a version range. |
| Different UI/options/settings available in different patches of the same minor | Example for a breaking change | Only keep the changes for the latest patch. If it’s a breaking change, keep both options, and explain the difference between versions with plain text. |
applies-switch directives where one item is for a specific version (it could also be intended as a version range) |
Example | Replace with an exact version or a version range. |
(Page-level) applies_to tags which list the same lifecycle with multiple versions |
Example #1 (integration docs) Example #2 |
1. Check list of identified integration docs to update. What to do about these? TBD. 2. For docs where a feature is added in a patch version as well as in the next minor, only keep the applies_to for the patch, i.e. the earlier minor (e.g., if stack: ga 9.1.0, ga 9.0.6, keep stack: ga 9.0.6) |
| Tags of the type: {applies_to}`stack: ga 8.19.0, unavailable 9.0.0, ga 9.1.0` | Example | TBD (maybe remove ga 8.19.0?) |
Some identified docs that need to be adjusted (not an exclusive list!):
https://github.com/elastic/opentelemetry/blob/main/docs/reference/edot-cloud-forwarder/aws.md
https://github.com/elastic/beats/blob/main/docs/reference/winlogbeat/winlogbeat-installation-script.md
https://github.com/elastic/beats/blob/main/docs/reference/metricbeat/metricbeat-installation-script.md
https://github.com/elastic/beats/blob/main/docs/reference/packetbeat/packetbeat-installation-script.md
https://github.com/elastic/beats/blob/main/docs/reference/filebeat/filebeat-installation-script.md
https://github.com/elastic/beats/blob/main/docs/reference/heartbeat/heartbeat-installation-script.md
https://github.com/elastic/beats/blob/main/docs/reference/auditbeat/auditbeat-installation-script.md
https://github.com/elastic/elastic-otel-java/blob/main/docs/reference/edot-java/configuration.md
https://github.com/elastic/opentelemetry/blob/main/docs/reference/edot-cloud-forwarder/aws.md
https://github.com/elastic/docs-content/blob/main/solutions/security/detect-and-alert/suppress-detection-alerts.md
https://github.com/elastic/docs-content/blob/main/contribute-docs/how-to/cumulative-docs/guidelines.md
https://github.com/elastic/beats/blob/main/docs/reference/filebeat/filebeat-input-cel.md