From 5636a8e103293a15d04efaba12daf29561526744 Mon Sep 17 00:00:00 2001 From: shainaraskas <58563081+shainaraskas@users.noreply.github.com> Date: Tue, 19 Mar 2024 14:37:38 -0400 Subject: [PATCH] [Docs] remove Kibana book-scoped attributes from 7.17 (#178759) --- .../development-functional-tests.asciidoc | 2 +- .../external-plugin-functional-tests.asciidoc | 5 ++- .../external-plugin-localization.asciidoc | 4 +- docs/gs-index.asciidoc | 4 -- docs/index.asciidoc | 14 ------- docs/maps/connect-to-ems.asciidoc | 1 - docs/maps/index.asciidoc | 4 -- docs/setup/docker.asciidoc | 5 +++ docs/setup/install.asciidoc | 2 +- docs/setup/settings.asciidoc | 38 +++++++++---------- docs/user/api.asciidoc | 30 +++++++-------- docs/user/canvas.asciidoc | 12 +++--- docs/user/dev-tools.asciidoc | 8 ++-- docs/user/discover.asciidoc | 8 ++-- docs/user/index.asciidoc | 16 ++++---- docs/user/management.asciidoc | 22 +++++------ docs/user/setup.asciidoc | 14 +++---- 17 files changed, 86 insertions(+), 103 deletions(-) diff --git a/docs/developer/contributing/development-functional-tests.asciidoc b/docs/developer/contributing/development-functional-tests.asciidoc index f1455b511e1dfc..de0a3e53b358c9 100644 --- a/docs/developer/contributing/development-functional-tests.asciidoc +++ b/docs/developer/contributing/development-functional-tests.asciidoc @@ -6,7 +6,7 @@ We use functional tests to make sure the {kib} UI works as expected. It replaces [discrete] === Running functional tests -The `FunctionalTestRunner` is very bare bones and gets most of its functionality from its config file, located at {blob}test/functional/config.js[test/functional/config.js] or {blob}x-pack/test/functional/config.js[x-pack/test/functional/config.js]. If you’re writing a plugin outside the {kib} repo, you will have your own config file. +The `FunctionalTestRunner` is very bare bones and gets most of its functionality from its config file. If you’re writing a plugin outside the {kib} repo, you will have your own config file. See <> for more info. There are three ways to run the tests depending on your goals: diff --git a/docs/developer/plugin/external-plugin-functional-tests.asciidoc b/docs/developer/plugin/external-plugin-functional-tests.asciidoc index 55b311794f9dcb..338faf0e0db876 100644 --- a/docs/developer/plugin/external-plugin-functional-tests.asciidoc +++ b/docs/developer/plugin/external-plugin-functional-tests.asciidoc @@ -10,7 +10,7 @@ Every project or plugin should have its own `FunctionalTestRunner` config file. To get started copy and paste this example to `test/functional/config.js`: -["source","js"] +["source","js",subs="attributes"] ----------- import { resolve } from 'path'; import { REPO_ROOT } from '@kbn/utils'; @@ -64,7 +64,8 @@ export default async function ({ readConfigFile }) { } // more settings, like timeouts, mochaOpts, etc are - // defined in the config schema. See {blob}src/functional_test_runner/lib/config/schema.js[src/functional_test_runner/lib/config/schema.js] + // defined in the config schema. + // See {kibana-blob}packages/kbn-test/src/functional_test_runner/lib/config/schema.ts }; } diff --git a/docs/developer/plugin/external-plugin-localization.asciidoc b/docs/developer/plugin/external-plugin-localization.asciidoc index a7234ae5982294..9e251f2f46d41f 100644 --- a/docs/developer/plugin/external-plugin-localization.asciidoc +++ b/docs/developer/plugin/external-plugin-localization.asciidoc @@ -47,9 +47,9 @@ To use {kib} i18n tooling, create a `.i18nrc.json` file with the following confi } ----------- -An example {kib} `.i18nrc.json` is {blob}.i18nrc.json[here]. +An example {kib} `.i18nrc.json` is {kibana-blob}.i18nrc.json[here]. -Full documentation about i18n tooling is {blob}src/dev/i18n/README.md[here]. +Full documentation about i18n tooling is {kibana-blob}src/dev/i18n/README.md[here]. [discrete] === Extracting default messages diff --git a/docs/gs-index.asciidoc b/docs/gs-index.asciidoc index 06996d382d90f8..d4e6a102dddf02 100644 --- a/docs/gs-index.asciidoc +++ b/docs/gs-index.asciidoc @@ -9,10 +9,6 @@ release-state can be: released | prerelease | unreleased :major-version: 5.4 :branch: 5.4 -:docker-image: docker.elastic.co/kibana/kibana:{version} -:es-ref: https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/ -:security: https://www.elastic.co/community/security/ - include::{docs-root}/shared/attributes.asciidoc[] include::introduction.asciidoc[] diff --git a/docs/index.asciidoc b/docs/index.asciidoc index b4f536bd872d63..7607d80b8af9a8 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -1,22 +1,8 @@ [[kibana-guide]] = Kibana Guide -:include-xpack: true -:lang: en -:kib-repo-dir: {kibana-root}/docs - include::{docs-root}/shared/versions/stack/{source_branch}.asciidoc[] -:docker-repo: docker.elastic.co/kibana/kibana -:docker-image: {docker-repo}:{version} -:es-docker-repo: docker.elastic.co/elasticsearch/elasticsearch -:es-docker-image: {es-docker-repo}:{version} -:blob: {kib-repo}blob/{branch}/ -:security-ref: https://www.elastic.co/community/security/ -:data-source: index pattern -:data-sources: index patterns -:a-data-source: an index pattern - include::{docs-root}/shared/attributes.asciidoc[] include::user/index.asciidoc[] diff --git a/docs/maps/connect-to-ems.asciidoc b/docs/maps/connect-to-ems.asciidoc index 5952d6f30d4b79..95476b51a402ee 100644 --- a/docs/maps/connect-to-ems.asciidoc +++ b/docs/maps/connect-to-ems.asciidoc @@ -4,7 +4,6 @@ :ems-docker-repo: docker.elastic.co/elastic-maps-service/elastic-maps-server-ubi8 :ems-docker-image: {ems-docker-repo}:{version} -:ems-headers-url: https://deployment-host https://www.elastic.co/elastic-maps-service[Elastic Maps Service (EMS)] is a service that hosts tile layers and vector shapes of administrative boundaries. diff --git a/docs/maps/index.asciidoc b/docs/maps/index.asciidoc index 157eb0f0446667..bf69fbf15f964e 100644 --- a/docs/maps/index.asciidoc +++ b/docs/maps/index.asciidoc @@ -1,7 +1,3 @@ -:ems-docker-repo: docker.elastic.co/elastic-maps-service/elastic-maps-server-ubi8 -:ems-docker-image: {ems-docker-repo}:{version} - -[role="xpack"] [[maps]] = Maps diff --git a/docs/setup/docker.asciidoc b/docs/setup/docker.asciidoc index a9450a4269e09c..537d664381af1c 100644 --- a/docs/setup/docker.asciidoc +++ b/docs/setup/docker.asciidoc @@ -4,6 +4,11 @@ Install with Docker ++++ +:docker-repo: docker.elastic.co/kibana/kibana +:docker-image: {docker-repo}:{version} +:es-docker-repo: docker.elastic.co/elasticsearch/elasticsearch +:es-docker-image: {es-docker-repo}:{version} + Docker images for {kib} are available from the Elastic Docker registry. The base image is https://hub.docker.com/_/ubuntu[ubuntu:20.04]. diff --git a/docs/setup/install.asciidoc b/docs/setup/install.asciidoc index cb47210cb3f089..abbfb0f27a6e5f 100644 --- a/docs/setup/install.asciidoc +++ b/docs/setup/install.asciidoc @@ -65,6 +65,6 @@ include::install/deb.asciidoc[] include::install/rpm.asciidoc[] -include::{kib-repo-dir}/setup/docker.asciidoc[] +include::{kibana-root}/docs/setup/docker.asciidoc[] include::install/brew.asciidoc[] diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index be5aebdf64a917..9ba80b23c0a75f 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -879,23 +879,23 @@ Set this value to false to disable the Upgrade Assistant UI. *Default: true* Set this value to change the {kib} interface language. Valid locales are: `en`, `zh-CN`, `ja-JP`. *Default: `en`* -include::{kib-repo-dir}/settings/alert-action-settings.asciidoc[] -include::{kib-repo-dir}/settings/apm-settings.asciidoc[] -include::{kib-repo-dir}/settings/banners-settings.asciidoc[] -include::{kib-repo-dir}/settings/dev-settings.asciidoc[] -include::{kib-repo-dir}/settings/graph-settings.asciidoc[] -include::{kib-repo-dir}/settings/fleet-settings.asciidoc[] -include::{kib-repo-dir}/settings/i18n-settings.asciidoc[] -include::{kib-repo-dir}/settings/logging-settings.asciidoc[] -include::{kib-repo-dir}/settings/logs-ui-settings.asciidoc[] -include::{kib-repo-dir}/settings/infrastructure-ui-settings.asciidoc[] -include::{kib-repo-dir}/settings/ml-settings.asciidoc[] -include::{kib-repo-dir}/settings/monitoring-settings.asciidoc[] -include::{kib-repo-dir}/settings/reporting-settings.asciidoc[] +include::{kibana-root}/docs/settings/alert-action-settings.asciidoc[] +include::{kibana-root}/docs/settings/apm-settings.asciidoc[] +include::{kibana-root}/docs/settings/banners-settings.asciidoc[] +include::{kibana-root}/docs/settings/dev-settings.asciidoc[] +include::{kibana-root}/docs/settings/graph-settings.asciidoc[] +include::{kibana-root}/docs/settings/fleet-settings.asciidoc[] +include::{kibana-root}/docs/settings/i18n-settings.asciidoc[] +include::{kibana-root}/docs/settings/logging-settings.asciidoc[] +include::{kibana-root}/docs/settings/logs-ui-settings.asciidoc[] +include::{kibana-root}/docs/settings/infrastructure-ui-settings.asciidoc[] +include::{kibana-root}/docs/settings/ml-settings.asciidoc[] +include::{kibana-root}/docs/settings/monitoring-settings.asciidoc[] +include::{kibana-root}/docs/settings/reporting-settings.asciidoc[] include::secure-settings.asciidoc[] -include::{kib-repo-dir}/settings/search-sessions-settings.asciidoc[] -include::{kib-repo-dir}/settings/security-settings.asciidoc[] -include::{kib-repo-dir}/settings/spaces-settings.asciidoc[] -include::{kib-repo-dir}/settings/task-manager-settings.asciidoc[] -include::{kib-repo-dir}/settings/telemetry-settings.asciidoc[] -include::{kib-repo-dir}/settings/url-drilldown-settings.asciidoc[] +include::{kibana-root}/docs/settings/search-sessions-settings.asciidoc[] +include::{kibana-root}/docs/settings/security-settings.asciidoc[] +include::{kibana-root}/docs/settings/spaces-settings.asciidoc[] +include::{kibana-root}/docs/settings/task-manager-settings.asciidoc[] +include::{kibana-root}/docs/settings/telemetry-settings.asciidoc[] +include::{kibana-root}/docs/settings/url-drilldown-settings.asciidoc[] diff --git a/docs/user/api.asciidoc b/docs/user/api.asciidoc index c8168807cc12a5..ef36ce6ea35314 100644 --- a/docs/user/api.asciidoc +++ b/docs/user/api.asciidoc @@ -88,18 +88,18 @@ curl -X POST \ -------------------------------------------- -include::{kib-repo-dir}/api/features.asciidoc[] -include::{kib-repo-dir}/api/spaces-management.asciidoc[] -include::{kib-repo-dir}/api/role-management.asciidoc[] -include::{kib-repo-dir}/api/session-management.asciidoc[] -include::{kib-repo-dir}/api/saved-objects.asciidoc[] -include::{kib-repo-dir}/api/index-patterns.asciidoc[] -include::{kib-repo-dir}/api/alerting.asciidoc[] -include::{kib-repo-dir}/api/actions-and-connectors.asciidoc[] -include::{kib-repo-dir}/api/cases.asciidoc[] -include::{kib-repo-dir}/api/dashboard-api.asciidoc[] -include::{kib-repo-dir}/api/logstash-configuration-management.asciidoc[] -include::{kib-repo-dir}/api/machine-learning.asciidoc[] -include::{kib-repo-dir}/api/short-urls.asciidoc[] -include::{kib-repo-dir}/api/task-manager/health.asciidoc[] -include::{kib-repo-dir}/api/upgrade-assistant.asciidoc[] +include::{kibana-root}/docs/api/features.asciidoc[] +include::{kibana-root}/docs/api/spaces-management.asciidoc[] +include::{kibana-root}/docs/api/role-management.asciidoc[] +include::{kibana-root}/docs/api/session-management.asciidoc[] +include::{kibana-root}/docs/api/saved-objects.asciidoc[] +include::{kibana-root}/docs/api/index-patterns.asciidoc[] +include::{kibana-root}/docs/api/alerting.asciidoc[] +include::{kibana-root}/docs/api/actions-and-connectors.asciidoc[] +include::{kibana-root}/docs/api/cases.asciidoc[] +include::{kibana-root}/docs/api/dashboard-api.asciidoc[] +include::{kibana-root}/docs/api/logstash-configuration-management.asciidoc[] +include::{kibana-root}/docs/api/machine-learning.asciidoc[] +include::{kibana-root}/docs/api/short-urls.asciidoc[] +include::{kibana-root}/docs/api/task-manager/health.asciidoc[] +include::{kibana-root}/docs/api/upgrade-assistant.asciidoc[] diff --git a/docs/user/canvas.asciidoc b/docs/user/canvas.asciidoc index 46f3e14e500334..1b99b379419ba8 100644 --- a/docs/user/canvas.asciidoc +++ b/docs/user/canvas.asciidoc @@ -193,14 +193,14 @@ Want to export multiple workpads? Go to the *Canvas* home page, select the workp -- -include::{kib-repo-dir}/canvas/canvas-edit-workpads.asciidoc[] +include::{kibana-root}/docs/canvas/canvas-edit-workpads.asciidoc[] -include::{kib-repo-dir}/canvas/canvas-present-workpad.asciidoc[] +include::{kibana-root}/docs/canvas/canvas-present-workpad.asciidoc[] -include::{kib-repo-dir}/canvas/canvas-tutorial.asciidoc[] +include::{kibana-root}/docs/canvas/canvas-tutorial.asciidoc[] -include::{kib-repo-dir}/canvas/canvas-expression-lifecycle.asciidoc[] +include::{kibana-root}/docs/canvas/canvas-expression-lifecycle.asciidoc[] -include::{kib-repo-dir}/canvas/canvas-function-reference.asciidoc[] +include::{kibana-root}/docs/canvas/canvas-function-reference.asciidoc[] -include::{kib-repo-dir}/canvas/canvas-tinymath-functions.asciidoc[] +include::{kibana-root}/docs/canvas/canvas-tinymath-functions.asciidoc[] diff --git a/docs/user/dev-tools.asciidoc b/docs/user/dev-tools.asciidoc index 0c5bef489dd011..3226fdcab7d908 100644 --- a/docs/user/dev-tools.asciidoc +++ b/docs/user/dev-tools.asciidoc @@ -30,10 +30,10 @@ a| <> -- -include::{kib-repo-dir}/dev-tools/console/console.asciidoc[] +include::{kibana-root}/docs/dev-tools/console/console.asciidoc[] -include::{kib-repo-dir}/dev-tools/searchprofiler/index.asciidoc[] +include::{kibana-root}/docs/dev-tools/searchprofiler/index.asciidoc[] -include::{kib-repo-dir}/dev-tools/grokdebugger/index.asciidoc[] +include::{kibana-root}/docs/dev-tools/grokdebugger/index.asciidoc[] -include::{kib-repo-dir}/dev-tools/painlesslab/index.asciidoc[] +include::{kibana-root}/docs/dev-tools/painlesslab/index.asciidoc[] diff --git a/docs/user/discover.asciidoc b/docs/user/discover.asciidoc index 1fd31944db271d..96d2168d643562 100644 --- a/docs/user/discover.asciidoc +++ b/docs/user/discover.asciidoc @@ -276,10 +276,10 @@ the table columns that display by default, and more. -- -include::{kib-repo-dir}/discover/view-document.asciidoc[] +include::{kibana-root}/docs/discover/view-document.asciidoc[] -include::{kib-repo-dir}/discover/search-for-relevance.asciidoc[] +include::{kibana-root}/docs/discover/search-for-relevance.asciidoc[] -include::{kib-repo-dir}/discover/save-search.asciidoc[] +include::{kibana-root}/docs/discover/save-search.asciidoc[] -include::{kib-repo-dir}/discover/search-sessions.asciidoc[] +include::{kibana-root}/docs/discover/search-sessions.asciidoc[] diff --git a/docs/user/index.asciidoc b/docs/user/index.asciidoc index 515b292d23b8d2..38211239b22a72 100644 --- a/docs/user/index.asciidoc +++ b/docs/user/index.asciidoc @@ -2,9 +2,9 @@ include::introduction.asciidoc[] include::whats-new.asciidoc[] -include::{kib-repo-dir}/concepts/index.asciidoc[] +include::{kibana-root}/docs/concepts/index.asciidoc[] -include::{kib-repo-dir}/getting-started/quick-start-guide.asciidoc[] +include::{kibana-root}/docs/getting-started/quick-start-guide.asciidoc[] include::setup.asciidoc[] @@ -16,7 +16,7 @@ include::dashboard/dashboard.asciidoc[] include::canvas.asciidoc[] -include::{kib-repo-dir}/maps/index.asciidoc[] +include::{kibana-root}/docs/maps/index.asciidoc[] include::reporting/index.asciidoc[] @@ -26,17 +26,17 @@ include::graph/index.asciidoc[] include::alerting/index.asciidoc[] -include::{kib-repo-dir}/observability/index.asciidoc[] +include::{kibana-root}/docs/observability/index.asciidoc[] -include::{kib-repo-dir}/apm/index.asciidoc[] +include::{kibana-root}/docs/apm/index.asciidoc[] -include::{kib-repo-dir}/siem/index.asciidoc[] +include::{kibana-root}/docs/siem/index.asciidoc[] include::dev-tools.asciidoc[] -include::{kib-repo-dir}/fleet/fleet.asciidoc[] +include::{kibana-root}/docs/fleet/fleet.asciidoc[] -include::{kib-repo-dir}/osquery/osquery.asciidoc[] +include::{kibana-root}/docs/osquery/osquery.asciidoc[] include::monitoring/index.asciidoc[] diff --git a/docs/user/management.asciidoc b/docs/user/management.asciidoc index 9c1f4a73397461..fbfbdafca9a8c7 100644 --- a/docs/user/management.asciidoc +++ b/docs/user/management.asciidoc @@ -177,26 +177,26 @@ next major version of {es}, and then reindex, if needed. -- -include::{kib-repo-dir}/management/advanced-options.asciidoc[] +include::{kibana-root}/docs/management/advanced-options.asciidoc[] -include::{kib-repo-dir}/management/action-types.asciidoc[] +include::{kibana-root}/docs/management/action-types.asciidoc[] -include::{kib-repo-dir}/management/managing-licenses.asciidoc[] +include::{kibana-root}/docs/management/managing-licenses.asciidoc[] -include::{kib-repo-dir}/management/manage-index-patterns.asciidoc[] +include::{kibana-root}/docs/management/manage-index-patterns.asciidoc[] -include::{kib-repo-dir}/management/numeral.asciidoc[] +include::{kibana-root}/docs/management/numeral.asciidoc[] -include::{kib-repo-dir}/management/rollups/create_and_manage_rollups.asciidoc[] +include::{kibana-root}/docs/management/rollups/create_and_manage_rollups.asciidoc[] -include::{kib-repo-dir}/management/managing-saved-objects.asciidoc[] +include::{kibana-root}/docs/management/managing-saved-objects.asciidoc[] include::security/index.asciidoc[] -include::{kib-repo-dir}/spaces/index.asciidoc[] +include::{kibana-root}/docs/spaces/index.asciidoc[] -include::{kib-repo-dir}/management/managing-tags.asciidoc[] +include::{kibana-root}/docs/management/managing-tags.asciidoc[] -include::{kib-repo-dir}/management/upgrade-assistant/index.asciidoc[] +include::{kibana-root}/docs/management/upgrade-assistant/index.asciidoc[] -include::{kib-repo-dir}/management/watcher-ui/index.asciidoc[] +include::{kibana-root}/docs/management/watcher-ui/index.asciidoc[] diff --git a/docs/user/setup.asciidoc b/docs/user/setup.asciidoc index 831b77530336a3..6bd1283685463b 100644 --- a/docs/user/setup.asciidoc +++ b/docs/user/setup.asciidoc @@ -49,23 +49,23 @@ encourage users to run the same versions of Kibana and Elasticsearch down to the patch version. -- -include::{kib-repo-dir}/setup/install.asciidoc[] +include::{kibana-root}/docs/setup/install.asciidoc[] -include::{kib-repo-dir}/setup/settings.asciidoc[] +include::{kibana-root}/docs/setup/settings.asciidoc[] -include::{kib-repo-dir}/setup/start-stop.asciidoc[] +include::{kibana-root}/docs/setup/start-stop.asciidoc[] -include::{kib-repo-dir}/setup/access.asciidoc[] +include::{kibana-root}/docs/setup/access.asciidoc[] include::security/tutorials/how-to-secure-access-to-kibana.asciidoc[] -include::{kib-repo-dir}/setup/connect-to-elasticsearch.asciidoc[] +include::{kibana-root}/docs/setup/connect-to-elasticsearch.asciidoc[] -include::{kib-repo-dir}/setup/upgrade.asciidoc[] +include::{kibana-root}/docs/setup/upgrade.asciidoc[] include::security/securing-kibana.asciidoc[] -include::{kib-repo-dir}/setup/configuring-reporting.asciidoc[] +include::{kibana-root}/docs/setup/configuring-reporting.asciidoc[] include::monitoring/configuring-monitoring.asciidoc[leveloffset=+1] include::monitoring/monitoring-metricbeat.asciidoc[leveloffset=+2]