mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
7da29174c7
# Backport This will backport the following commits from `main` to `8.18`: - [Support local file path for `xpack.productDocBase.artifactRepositoryUrl` (#217046)](https://github.com/elastic/kibana/pull/217046) <!--- Backport version: 10.0.1 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Dima Arnautov","email":"dmitrii.arnautov@elastic.co"},"sourceCommit":{"committedDate":"2025-04-14T13:27:41Z","message":"Support local file path for `xpack.productDocBase.artifactRepositoryUrl` (#217046)\n\n## Summary\n\nCloses https://github.com/elastic/kibana/issues/216583\n\nAdds support for a local file path in\n`xpack.productDocBase.artifactRepositoryUrl` setting.\nIf local path with `file://` protocol is provided, it has to contain a\npath to a directory with the artifacts and the `index.xml` file.\n\n#### How to test \n\n1. Download the XML and zip files from\nhttps://kibana-knowledge-base-artifacts.elastic.co\n2. Create a folder, e.g. `mkdir /Users/<my_user>/test_artifacts` and\nplace all the files there. The XML file has to be called `index.xml`\n3. Add `xpack.productDocBase.artifactRepositoryUrl:\n'file:///Users/<my_user>/test_artifacts'` to your `kibana.dev.yml`\n4. Go to `/app/management/kibana/observabilityAiAssistantManagement` in\nKibana and install Elastic documentation\n5. Kibana dev server should report `[2025-04-07T14:05:10.640+02:00][INFO\n][plugins.productDocBase.package-installer] Documentation installation\nsuccessful for product [security] and version [8.17]`\n6. Check `data/ai-kb-artifacts` folder in your Kibana repo, it should\ncontain zip files with docs\n\n### Checklist\n\n- [x] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [x] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"6722f142a4d36f0c84c9eb258287900f2f559389","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:enhancement",":ml","Team:ML","backport:version","v9.1.0","v8.19.0"],"title":"Support local file path for `xpack.productDocBase.artifactRepositoryUrl`","number":217046,"url":"https://github.com/elastic/kibana/pull/217046","mergeCommit":{"message":"Support local file path for `xpack.productDocBase.artifactRepositoryUrl` (#217046)\n\n## Summary\n\nCloses https://github.com/elastic/kibana/issues/216583\n\nAdds support for a local file path in\n`xpack.productDocBase.artifactRepositoryUrl` setting.\nIf local path with `file://` protocol is provided, it has to contain a\npath to a directory with the artifacts and the `index.xml` file.\n\n#### How to test \n\n1. Download the XML and zip files from\nhttps://kibana-knowledge-base-artifacts.elastic.co\n2. Create a folder, e.g. `mkdir /Users/<my_user>/test_artifacts` and\nplace all the files there. The XML file has to be called `index.xml`\n3. Add `xpack.productDocBase.artifactRepositoryUrl:\n'file:///Users/<my_user>/test_artifacts'` to your `kibana.dev.yml`\n4. Go to `/app/management/kibana/observabilityAiAssistantManagement` in\nKibana and install Elastic documentation\n5. Kibana dev server should report `[2025-04-07T14:05:10.640+02:00][INFO\n][plugins.productDocBase.package-installer] Documentation installation\nsuccessful for product [security] and version [8.17]`\n6. Check `data/ai-kb-artifacts` folder in your Kibana repo, it should\ncontain zip files with docs\n\n### Checklist\n\n- [x] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [x] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"6722f142a4d36f0c84c9eb258287900f2f559389"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/217046","number":217046,"mergeCommit":{"message":"Support local file path for `xpack.productDocBase.artifactRepositoryUrl` (#217046)\n\n## Summary\n\nCloses https://github.com/elastic/kibana/issues/216583\n\nAdds support for a local file path in\n`xpack.productDocBase.artifactRepositoryUrl` setting.\nIf local path with `file://` protocol is provided, it has to contain a\npath to a directory with the artifacts and the `index.xml` file.\n\n#### How to test \n\n1. Download the XML and zip files from\nhttps://kibana-knowledge-base-artifacts.elastic.co\n2. Create a folder, e.g. `mkdir /Users/<my_user>/test_artifacts` and\nplace all the files there. The XML file has to be called `index.xml`\n3. Add `xpack.productDocBase.artifactRepositoryUrl:\n'file:///Users/<my_user>/test_artifacts'` to your `kibana.dev.yml`\n4. Go to `/app/management/kibana/observabilityAiAssistantManagement` in\nKibana and install Elastic documentation\n5. Kibana dev server should report `[2025-04-07T14:05:10.640+02:00][INFO\n][plugins.productDocBase.package-installer] Documentation installation\nsuccessful for product [security] and version [8.17]`\n6. Check `data/ai-kb-artifacts` folder in your Kibana repo, it should\ncontain zip files with docs\n\n### Checklist\n\n- [x] Any text added follows [EUI's writing\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\nsentence case text and includes [i18n\nsupport](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md)\n- [x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n- [x] [Unit or functional\ntests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)\nwere updated or added to match the most common scenarios\n- [x] The PR description includes the appropriate Release Notes section,\nand the correct `release_note:*` label is applied per the\n[guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)","sha":"6722f142a4d36f0c84c9eb258287900f2f559389"}},{"branch":"8.x","label":"v8.19.0","branchLabelMappingKey":"^v8.19.0$","isSourceBranch":false,"state":"NOT_CREATED"},{"url":"https://github.com/elastic/kibana/pull/219083","number":219083,"branch":"8.19","state":"MERGED","mergeCommit":{"sha":"de3d30aeda57436d96a0d6142e315bc076376657","message":"[8.19] Support local file path for `xpack.productDocBase.artifactRepositoryUrl` (#217046) (#219083)\n\n# Backport\n\nThis will backport the following commits from `main` to `8.19`:\n- [Support local file path for\n`xpack.productDocBase.artifactRepositoryUrl`\n(#217046)](https://github.com/elastic/kibana/pull/217046)\n\n\n\n### Questions ?\nPlease refer to the [Backport tool\ndocumentation](https://github.com/sorenlouv/backport)\n\n\n\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>"}}]}] BACKPORT--> |
||
|---|---|---|
| .. | ||
| images | ||
| ai-assistant-settings.asciidoc | ||
| alert-action-settings.asciidoc | ||
| apm-settings.asciidoc | ||
| banners-settings.asciidoc | ||
| cases-settings.asciidoc | ||
| enterprise-search-settings.asciidoc | ||
| fleet-settings.asciidoc | ||
| general-infra-logs-ui-settings.asciidoc | ||
| i18n-settings.asciidoc | ||
| infrastructure-ui-settings.asciidoc | ||
| logging-settings.asciidoc | ||
| logs-ui-settings.asciidoc | ||
| monitoring-settings.asciidoc | ||
| reporting-settings.asciidoc | ||
| search-sessions-settings.asciidoc | ||
| security-settings.asciidoc | ||
| spaces-settings.asciidoc | ||
| task-manager-settings.asciidoc | ||
| telemetry-settings.asciidoc | ||
| url-drilldown-settings.asciidoc | ||