[Security Solution][Elastic AI Assistant] Updates ESQL Knowledge Base docs to latest #169593
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spong
added
bug
|
Pinging @elastic/security-solution (Team: SecuritySolution) |
|
Documentation preview: |
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: cc @spong |
andrew-goldstein
approved these changes
Oct 24, 2023
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Oct 26, 2023
… 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)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Oct 26, 2023
…ge Base docs to latest (#169593) (#169950) # Backport This will backport the following commits from `main` to `8.11`: - [[Security Solution][Elastic AI Assistant] Updates ESQL Knowledge Base docs to latest (#169593)](#169593) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Garrett Spong","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-10-26T14:45:05Z","message":"[Security Solution][Elastic AI Assistant] Updates ESQL Knowledge Base docs to latest (#169593)\n\n## Summary\r\n\r\nIn preparation for the final `8.11` BC, this PR updates the Assistant\r\nESQL Knowledge Base docs to match that of the latest [Elasticsearch ESQL\r\ndocumentation](https://github.com/elastic/elasticsearch/tree/main/docs/reference/esql)\r\nand [language\r\nfiles](https://github.com/elastic/elasticsearch/tree/f883dd98566c1f8ffa34779c9949eaeb27596014/x-pack/plugin/esql/src/main/antlr).\r\n\r\n\r\n## Update process\r\n\r\nTo update, I deleted the\r\n`x-pack/plugins/elastic_assistant/server/knowledge_base/documentation`\r\nfolder contents, then copied the latest [Elasticsearch ESQL\r\ndocumentation](https://github.com/elastic/elasticsearch/tree/main/docs/reference/esql)\r\nfiles over. Then ran the below script from that directory via terminal\r\nto rename all files/directories from `kebab-case` to `snake_case` as\r\nrequired by the Kibana repo:\r\n\r\n> find . -depth -name '*-*' -exec bash -c 'for f; do base=${f##*/}; mv\r\n-- \"$f\" \"${f%/*}/${base//-/_}\"; done' bash {} +\r\n\r\n\r\nFor the language files, I checked those manually and copied over the\r\nentire file contents since there are only 4.\r\n\r\nWhen we do the next update, (and confirm these raw `asciidocs` are the\r\nbest format), I will create a single script that can be run for\r\nmaintenance purposes.","sha":"b0f8c5bcf02bd6f6494b3a7ddf6ba757f6f630c8","branchLabelMapping":{"^v8.12.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:skip","Team: SecuritySolution","Feature:Elastic AI Assistant","v8.11.0","v8.12.0"],"number":169593,"url":"https://github.com/elastic/kibana/pull/169593","mergeCommit":{"message":"[Security Solution][Elastic AI Assistant] Updates ESQL Knowledge Base docs to latest (#169593)\n\n## Summary\r\n\r\nIn preparation for the final `8.11` BC, this PR updates the Assistant\r\nESQL Knowledge Base docs to match that of the latest [Elasticsearch ESQL\r\ndocumentation](https://github.com/elastic/elasticsearch/tree/main/docs/reference/esql)\r\nand [language\r\nfiles](https://github.com/elastic/elasticsearch/tree/f883dd98566c1f8ffa34779c9949eaeb27596014/x-pack/plugin/esql/src/main/antlr).\r\n\r\n\r\n## Update process\r\n\r\nTo update, I deleted the\r\n`x-pack/plugins/elastic_assistant/server/knowledge_base/documentation`\r\nfolder contents, then copied the latest [Elasticsearch ESQL\r\ndocumentation](https://github.com/elastic/elasticsearch/tree/main/docs/reference/esql)\r\nfiles over. Then ran the below script from that directory via terminal\r\nto rename all files/directories from `kebab-case` to `snake_case` as\r\nrequired by the Kibana repo:\r\n\r\n> find . -depth -name '*-*' -exec bash -c 'for f; do base=${f##*/}; mv\r\n-- \"$f\" \"${f%/*}/${base//-/_}\"; done' bash {} +\r\n\r\n\r\nFor the language files, I checked those manually and copied over the\r\nentire file contents since there are only 4.\r\n\r\nWhen we do the next update, (and confirm these raw `asciidocs` are the\r\nbest format), I will create a single script that can be run for\r\nmaintenance purposes.","sha":"b0f8c5bcf02bd6f6494b3a7ddf6ba757f6f630c8"}},"sourceBranch":"main","suggestedTargetBranches":["8.11"],"targetPullRequestStates":[{"branch":"8.11","label":"v8.11.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.12.0","labelRegex":"^v8.12.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/169593","number":169593,"mergeCommit":{"message":"[Security Solution][Elastic AI Assistant] Updates ESQL Knowledge Base docs to latest (#169593)\n\n## Summary\r\n\r\nIn preparation for the final `8.11` BC, this PR updates the Assistant\r\nESQL Knowledge Base docs to match that of the latest [Elasticsearch ESQL\r\ndocumentation](https://github.com/elastic/elasticsearch/tree/main/docs/reference/esql)\r\nand [language\r\nfiles](https://github.com/elastic/elasticsearch/tree/f883dd98566c1f8ffa34779c9949eaeb27596014/x-pack/plugin/esql/src/main/antlr).\r\n\r\n\r\n## Update process\r\n\r\nTo update, I deleted the\r\n`x-pack/plugins/elastic_assistant/server/knowledge_base/documentation`\r\nfolder contents, then copied the latest [Elasticsearch ESQL\r\ndocumentation](https://github.com/elastic/elasticsearch/tree/main/docs/reference/esql)\r\nfiles over. Then ran the below script from that directory via terminal\r\nto rename all files/directories from `kebab-case` to `snake_case` as\r\nrequired by the Kibana repo:\r\n\r\n> find . -depth -name '*-*' -exec bash -c 'for f; do base=${f##*/}; mv\r\n-- \"$f\" \"${f%/*}/${base//-/_}\"; done' bash {} +\r\n\r\n\r\nFor the language files, I checked those manually and copied over the\r\nentire file contents since there are only 4.\r\n\r\nWhen we do the next update, (and confirm these raw `asciidocs` are the\r\nbest format), I will create a single script that can be run for\r\nmaintenance purposes.","sha":"b0f8c5bcf02bd6f6494b3a7ddf6ba757f6f630c8"}}]}] BACKPORT--> Co-authored-by: Garrett Spong <[email protected]>
This was referenced Jan 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
In preparation for the final
8.11BC, this PR updates the Assistant ESQL Knowledge Base docs to match that of the latest Elasticsearch ESQL documentation and language files.Update process
To update, I deleted the
x-pack/plugins/elastic_assistant/server/knowledge_base/documentationfolder contents, then copied the latest Elasticsearch ESQL documentation files over. Then ran the below script from that directory via terminal to rename all files/directories fromkebab-casetosnake_caseas required by the Kibana repo: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
asciidocsare the best format), I will create a single script that can be run for maintenance purposes.