Convert Alert and Action Settings yaml strings to Markdown (#214642)

Browse source

This PR:
- Makes a backup copy of the `kibana-alert-action-settings.yml` file
just in case I mess things up badly.
- Converts all of the descriptions and examples in the original file to
Markdown format.
 - Adds the versioning info as follows:
      - supported on ESS/ECH:
        ```
        applies_to:
          stack: ga
          deployment:
            self: ga
            ess: ga
        ``` 
      - not supported on ESS/ECH:
        ```
        applies_to:
          stack: ga
          deployment:
            self: ga
        ``` 

In the current Kibana settings docs we indicate settings available on
ESS/ECH. We don't indicate anything for other deployment types such as
ECK or ECE. I assume that no settings are available on Serverless. So,
the above versioning basically just copies what we document currently.

Once merged, I expect that we can test rendering the docs HTML pages
(like [this
one](https://www.elastic.co/guide/en/kibana/8.x/alert-action-settings-kb.html))
directly from this [YAML
source](https://github.com/elastic/kibana/blob/main/docs/settings-gen/source/kibana-alert-action-settings.yml).

@florent-leborgne and @wajihaparvez Sorry, I know this is kind of big.
I'd appreciate any input, especially on the versioning / `applies_to`
part since that's still a bit new.

Just for my own reference, I cut and pasted all of the Markdown from
[here](https://github.com/elastic/asciidocalypse/blob/main/docs/kibana/docs/reference/configuration-reference/alerting-settings.md?plain=1).

Closes: https://github.com/elastic/ingest-docs/issues/1659

...

This commit is contained in:

David Kilfoyle 2025-03-17 11:39:26 -04:00 • committed by GitHub

parent 68749db959

commit be351d3c97

No known key found for this signature in database

GPG key ID: B5690EEEBB952194

2 changed files with 2929 additions and 349 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download patch file Download diff file Expand all files Collapse all files

2330

docs/settings-gen/source/kibana-alert-action-settings-old.yml Normal file

View file

File diff suppressed because it is too large Load diff

948

docs/settings-gen/source/kibana-alert-action-settings.yml

View file

File diff suppressed because it is too large Load diff