github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[9.0] Convert Alert and Action Settings yaml strings to Markdown (#214642) (#214806)

Browse source 
# Backport

This will backport the following commits from `main` to `9.0`:
- [Convert Alert and Action Settings yaml strings to Markdown
(#214642)](https://github.com/elastic/kibana/pull/214642)

<!--- Backport version: 9.6.6 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"David
Kilfoyle","email":"41695641+kilfoyle@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-03-17T15:39:26Z","message":"Convert
Alert and Action Settings yaml strings to Markdown (#214642)\n\nThis
PR:\n- Makes a backup copy of the `kibana-alert-action-settings.yml`
file\njust in case I mess things up badly.\n- Converts all of the
descriptions and examples in the original file to\nMarkdown format.\n -
Adds the versioning info as follows:\n - supported on ESS/ECH:\n ```\n
applies_to:\n stack: ga\n deployment:\n self: ga\n ess: ga\n ``` \n -
not supported on ESS/ECH:\n ```\n applies_to:\n stack: ga\n
deployment:\n self: ga\n ``` \n\nIn the current Kibana settings docs we
indicate settings available on\nESS/ECH. We don't indicate anything for
other deployment types such as\nECK or ECE. I assume that no settings
are available on Serverless. So,\nthe above versioning basically just
copies what we document currently.\n\nOnce merged, I expect that we can
test rendering the docs HTML pages\n(like
[this\none](https://www.elastic.co/guide/en/kibana/8.x/alert-action-settings-kb.html))\ndirectly
from this
[YAML\nsource](https://github.com/elastic/kibana/blob/main/docs/settings-gen/source/kibana-alert-action-settings.yml).\n\n@florent-leborgne
and @wajihaparvez Sorry, I know this is kind of big.\nI'd appreciate any
input, especially on the versioning / `applies_to`\npart since that's
still a bit new.\n\nJust for my own reference, I cut and pasted all of
the Markdown
from\n[here](https://github.com/elastic/asciidocalypse/blob/main/docs/kibana/docs/reference/configuration-reference/alerting-settings.md?plain=1).\n\nCloses:
https://github.com/elastic/ingest-docs/issues/1659","sha":"be351d3c973978f56d8b527d4878911e0ade68eb","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","backport:version","v9.1.0"],"title":"Convert
Alert and Action Settings yaml strings to
Markdown","number":214642,"url":"https://github.com/elastic/kibana/pull/214642","mergeCommit":{"message":"Convert
Alert and Action Settings yaml strings to Markdown (#214642)\n\nThis
PR:\n- Makes a backup copy of the `kibana-alert-action-settings.yml`
file\njust in case I mess things up badly.\n- Converts all of the
descriptions and examples in the original file to\nMarkdown format.\n -
Adds the versioning info as follows:\n - supported on ESS/ECH:\n ```\n
applies_to:\n stack: ga\n deployment:\n self: ga\n ess: ga\n ``` \n -
not supported on ESS/ECH:\n ```\n applies_to:\n stack: ga\n
deployment:\n self: ga\n ``` \n\nIn the current Kibana settings docs we
indicate settings available on\nESS/ECH. We don't indicate anything for
other deployment types such as\nECK or ECE. I assume that no settings
are available on Serverless. So,\nthe above versioning basically just
copies what we document currently.\n\nOnce merged, I expect that we can
test rendering the docs HTML pages\n(like
[this\none](https://www.elastic.co/guide/en/kibana/8.x/alert-action-settings-kb.html))\ndirectly
from this
[YAML\nsource](https://github.com/elastic/kibana/blob/main/docs/settings-gen/source/kibana-alert-action-settings.yml).\n\n@florent-leborgne
and @wajihaparvez Sorry, I know this is kind of big.\nI'd appreciate any
input, especially on the versioning / `applies_to`\npart since that's
still a bit new.\n\nJust for my own reference, I cut and pasted all of
the Markdown
from\n[here](https://github.com/elastic/asciidocalypse/blob/main/docs/kibana/docs/reference/configuration-reference/alerting-settings.md?plain=1).\n\nCloses:
https://github.com/elastic/ingest-docs/issues/1659","sha":"be351d3c973978f56d8b527d4878911e0ade68eb"}},"sourceBranch":"main","suggestedTargetBranches":["9.0"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/214642","number":214642,"mergeCommit":{"message":"Convert
Alert and Action Settings yaml strings to Markdown (#214642)\n\nThis
PR:\n- Makes a backup copy of the `kibana-alert-action-settings.yml`
file\njust in case I mess things up badly.\n- Converts all of the
descriptions and examples in the original file to\nMarkdown format.\n -
Adds the versioning info as follows:\n - supported on ESS/ECH:\n ```\n
applies_to:\n stack: ga\n deployment:\n self: ga\n ess: ga\n ``` \n -
not supported on ESS/ECH:\n ```\n applies_to:\n stack: ga\n
deployment:\n self: ga\n ``` \n\nIn the current Kibana settings docs we
indicate settings available on\nESS/ECH. We don't indicate anything for
other deployment types such as\nECK or ECE. I assume that no settings
are available on Serverless. So,\nthe above versioning basically just
copies what we document currently.\n\nOnce merged, I expect that we can
test rendering the docs HTML pages\n(like
[this\none](https://www.elastic.co/guide/en/kibana/8.x/alert-action-settings-kb.html))\ndirectly
from this
[YAML\nsource](https://github.com/elastic/kibana/blob/main/docs/settings-gen/source/kibana-alert-action-settings.yml).\n\n@florent-leborgne
and @wajihaparvez Sorry, I know this is kind of big.\nI'd appreciate any
input, especially on the versioning / `applies_to`\npart since that's
still a bit new.\n\nJust for my own reference, I cut and pasted all of
the Markdown
from\n[here](https://github.com/elastic/asciidocalypse/blob/main/docs/kibana/docs/reference/configuration-reference/alerting-settings.md?plain=1).\n\nCloses:
https://github.com/elastic/ingest-docs/issues/1659","sha":"be351d3c973978f56d8b527d4878911e0ade68eb"}}]}]
BACKPORT-->

Co-authored-by: David Kilfoyle <41695641+kilfoyle@users.noreply.github.com>
This commit is contained in:
Kibana Machine 2025-03-17 17:14:34 +01:00 • committed by GitHub
parent 88b05d2315
commit 5c8e1a4726
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 2929 additions and 349 deletions
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