Skip to content
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

[8.11] [Security Solution][Elastic AI Assistant] Updates ESQL Knowledge Base docs to latest (#169593) #169950

Merged
merged 1 commit into from
Oct 26, 2023

Conversation

kibanamachine
Copy link
Contributor

Backport

This will backport the following commits from main to 8.11:

Questions ?

Please refer to the Backport tool documentation

… docs to latest (elastic#169593)

## Summary

In preparation for the final `8.11` BC, this PR updates the Assistant
ESQL Knowledge Base docs to match that of the latest [Elasticsearch ESQL
documentation](https://github.com/elastic/elasticsearch/tree/main/docs/reference/esql)
and [language
files](https://github.com/elastic/elasticsearch/tree/f883dd98566c1f8ffa34779c9949eaeb27596014/x-pack/plugin/esql/src/main/antlr).

## Update process

To update, I deleted the
`x-pack/plugins/elastic_assistant/server/knowledge_base/documentation`
folder contents, then copied the latest [Elasticsearch ESQL
documentation](https://github.com/elastic/elasticsearch/tree/main/docs/reference/esql)
files over. Then ran the below script from that directory via terminal
to rename all files/directories from `kebab-case` to `snake_case` as
required by the Kibana repo:

> find . -depth -name '*-*' -exec bash -c 'for f; do base=${f##*/}; mv
-- "$f" "${f%/*}/${base//-/_}"; done' bash {} +

For the language files, I checked those manually and copied over the
entire file contents since there are only 4.

When we do the next update, (and confirm these raw `asciidocs` are the
best format), I will create a single script that can be run for
maintenance purposes.

(cherry picked from commit b0f8c5b)
@github-actions
Copy link
Contributor

Documentation preview:

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #31 / Cloud Security Posture Findings Page Table Sort sorts by a column, should be case sensitive/insensitive depending on the column

Metrics [docs]

✅ unchanged

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @spong

@kibanamachine kibanamachine merged commit 34ea138 into elastic:8.11 Oct 26, 2023
21 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants