Skip to content

Commit

Permalink
[8.x] Sustainable Kibana Architecture: Move modules owned by `@elasti…
Browse files Browse the repository at this point in the history
…c/docs` (elastic#202416) (elastic#203401)

# Backport

This will backport the following commits from `main` to `8.x`:
- [Sustainable Kibana Architecture: Move modules owned by
`@elastic/docs`
(elastic#202416)](elastic#202416)

<!--- Backport version: 8.9.8 -->

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

<!--BACKPORT [{"author":{"name":"Gerard
Soldevila","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-12-05T13:54:58Z","message":"Sustainable
Kibana Architecture: Move modules owned by `@elastic/docs`
(elastic#202416)\n\n## Summary\r\n\r\nThis PR aims at relocating some of the
Kibana modules (plugins and\r\npackages) into a new folder structure,
according to the _Sustainable\r\nKibana Architecture_ initiative. We
kindly ask you to:\r\n\r\n* Review the moved files, as some of them
contain relative paths that\r\nhave been updated.\r\n* Review the
updated files, as some of them contain references that have\r\nbeen
updated.\r\n* Think of potential impact of the move, including tooling
and\r\nconfiguration files that can be pointing to the relocated
modules. E.g.:\r\n * customised eslint rules\r\n * docs pointing to
source code\r\n* We kindly ask you to:\r\n* Search for the
`packages[\\/\\\\]` and `plugins[\\/\\\\]` patterns in the\r\nsource
code (Babel and Eslint config files), and update
them\r\nappropriately.\r\n* Manually review
.buildkite/scripts/pipelines/pull_request/pipeline.ts\r\nto ensure that
any CI pipeline customizations continue to be correctly\r\napplied after
the changed path names\r\n* Review all of the updated files, specially
the `.ts` and `.js` files\r\nlisted in the sections
below.\r\n\r\n\r\n#### 1 package(s) are going to be relocated:\r\n\r\n |
Id | Target folder |\r\n | -- | ------------- |\r\n | `@kbn/doc-links` |
`src/platform/packages/shared/kbn-doc-links`
|\r\n\r\n\r\n<details>\r\n<summary>Updated
references</summary>\r\n\r\n```\r\n./docs/upgrade-notes.asciidoc\r\n./package.json\r\n./packages/kbn-repo-packages/package-map.json\r\n./packages/kbn-ts-projects/config-paths.json\r\n./src/core/tsconfig.type_check.json\r\n./src/platform/packages/shared/kbn-doc-links/jest.config.js\r\n./src/plugins/ai_assistant_management/selection/tsconfig.type_check.json\r\n./tsconfig.base.json\r\n./tsconfig.base.type_check.json\r\n./tsconfig.refs.json\r\n./x-pack/plugins/alerting/tsconfig.type_check.json\r\n./x-pack/plugins/search_connectors/tsconfig.type_check.json\r\n./x-pack/plugins/search_inference_endpoints/tsconfig.type_check.json\r\n./x-pack/plugins/search_playground/tsconfig.type_check.json\r\n./x-pack/plugins/security_solution/tsconfig.type_check.json\r\n./x-pack/plugins/serverless_search/tsconfig.type_check.json\r\n./x-pack/plugins/threat_intelligence/tsconfig.type_check.json\r\n./yarn.lock\r\n```\r\n</details>\r\n<details>\r\n<summary>Updated
relative
paths</summary>\r\n\r\n```\r\nsrc/platform/packages/shared/kbn-doc-links/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-doc-links/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-doc-links/tsconfig.type_check.json:2\r\n```\r\n</details>\r\n<details>\r\n<summary>Script
errors</summary>\r\n\r\n```\r\n\r\n```\r\n</details>","sha":"b2d49b8beb1d92bc2af45f67c6170bc58f26cec9","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","Team:Core","release_note:skip","backport
missing","v9.0.0","backport:prev-minor"],"number":202416,"url":"https://github.com/elastic/kibana/pull/202416","mergeCommit":{"message":"Sustainable
Kibana Architecture: Move modules owned by `@elastic/docs`
(elastic#202416)\n\n## Summary\r\n\r\nThis PR aims at relocating some of the
Kibana modules (plugins and\r\npackages) into a new folder structure,
according to the _Sustainable\r\nKibana Architecture_ initiative. We
kindly ask you to:\r\n\r\n* Review the moved files, as some of them
contain relative paths that\r\nhave been updated.\r\n* Review the
updated files, as some of them contain references that have\r\nbeen
updated.\r\n* Think of potential impact of the move, including tooling
and\r\nconfiguration files that can be pointing to the relocated
modules. E.g.:\r\n * customised eslint rules\r\n * docs pointing to
source code\r\n* We kindly ask you to:\r\n* Search for the
`packages[\\/\\\\]` and `plugins[\\/\\\\]` patterns in the\r\nsource
code (Babel and Eslint config files), and update
them\r\nappropriately.\r\n* Manually review
.buildkite/scripts/pipelines/pull_request/pipeline.ts\r\nto ensure that
any CI pipeline customizations continue to be correctly\r\napplied after
the changed path names\r\n* Review all of the updated files, specially
the `.ts` and `.js` files\r\nlisted in the sections
below.\r\n\r\n\r\n#### 1 package(s) are going to be relocated:\r\n\r\n |
Id | Target folder |\r\n | -- | ------------- |\r\n | `@kbn/doc-links` |
`src/platform/packages/shared/kbn-doc-links`
|\r\n\r\n\r\n<details>\r\n<summary>Updated
references</summary>\r\n\r\n```\r\n./docs/upgrade-notes.asciidoc\r\n./package.json\r\n./packages/kbn-repo-packages/package-map.json\r\n./packages/kbn-ts-projects/config-paths.json\r\n./src/core/tsconfig.type_check.json\r\n./src/platform/packages/shared/kbn-doc-links/jest.config.js\r\n./src/plugins/ai_assistant_management/selection/tsconfig.type_check.json\r\n./tsconfig.base.json\r\n./tsconfig.base.type_check.json\r\n./tsconfig.refs.json\r\n./x-pack/plugins/alerting/tsconfig.type_check.json\r\n./x-pack/plugins/search_connectors/tsconfig.type_check.json\r\n./x-pack/plugins/search_inference_endpoints/tsconfig.type_check.json\r\n./x-pack/plugins/search_playground/tsconfig.type_check.json\r\n./x-pack/plugins/security_solution/tsconfig.type_check.json\r\n./x-pack/plugins/serverless_search/tsconfig.type_check.json\r\n./x-pack/plugins/threat_intelligence/tsconfig.type_check.json\r\n./yarn.lock\r\n```\r\n</details>\r\n<details>\r\n<summary>Updated
relative
paths</summary>\r\n\r\n```\r\nsrc/platform/packages/shared/kbn-doc-links/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-doc-links/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-doc-links/tsconfig.type_check.json:2\r\n```\r\n</details>\r\n<details>\r\n<summary>Script
errors</summary>\r\n\r\n```\r\n\r\n```\r\n</details>","sha":"b2d49b8beb1d92bc2af45f67c6170bc58f26cec9"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/202416","number":202416,"mergeCommit":{"message":"Sustainable
Kibana Architecture: Move modules owned by `@elastic/docs`
(elastic#202416)\n\n## Summary\r\n\r\nThis PR aims at relocating some of the
Kibana modules (plugins and\r\npackages) into a new folder structure,
according to the _Sustainable\r\nKibana Architecture_ initiative. We
kindly ask you to:\r\n\r\n* Review the moved files, as some of them
contain relative paths that\r\nhave been updated.\r\n* Review the
updated files, as some of them contain references that have\r\nbeen
updated.\r\n* Think of potential impact of the move, including tooling
and\r\nconfiguration files that can be pointing to the relocated
modules. E.g.:\r\n * customised eslint rules\r\n * docs pointing to
source code\r\n* We kindly ask you to:\r\n* Search for the
`packages[\\/\\\\]` and `plugins[\\/\\\\]` patterns in the\r\nsource
code (Babel and Eslint config files), and update
them\r\nappropriately.\r\n* Manually review
.buildkite/scripts/pipelines/pull_request/pipeline.ts\r\nto ensure that
any CI pipeline customizations continue to be correctly\r\napplied after
the changed path names\r\n* Review all of the updated files, specially
the `.ts` and `.js` files\r\nlisted in the sections
below.\r\n\r\n\r\n#### 1 package(s) are going to be relocated:\r\n\r\n |
Id | Target folder |\r\n | -- | ------------- |\r\n | `@kbn/doc-links` |
`src/platform/packages/shared/kbn-doc-links`
|\r\n\r\n\r\n<details>\r\n<summary>Updated
references</summary>\r\n\r\n```\r\n./docs/upgrade-notes.asciidoc\r\n./package.json\r\n./packages/kbn-repo-packages/package-map.json\r\n./packages/kbn-ts-projects/config-paths.json\r\n./src/core/tsconfig.type_check.json\r\n./src/platform/packages/shared/kbn-doc-links/jest.config.js\r\n./src/plugins/ai_assistant_management/selection/tsconfig.type_check.json\r\n./tsconfig.base.json\r\n./tsconfig.base.type_check.json\r\n./tsconfig.refs.json\r\n./x-pack/plugins/alerting/tsconfig.type_check.json\r\n./x-pack/plugins/search_connectors/tsconfig.type_check.json\r\n./x-pack/plugins/search_inference_endpoints/tsconfig.type_check.json\r\n./x-pack/plugins/search_playground/tsconfig.type_check.json\r\n./x-pack/plugins/security_solution/tsconfig.type_check.json\r\n./x-pack/plugins/serverless_search/tsconfig.type_check.json\r\n./x-pack/plugins/threat_intelligence/tsconfig.type_check.json\r\n./yarn.lock\r\n```\r\n</details>\r\n<details>\r\n<summary>Updated
relative
paths</summary>\r\n\r\n```\r\nsrc/platform/packages/shared/kbn-doc-links/jest.config.js:12\r\nsrc/platform/packages/shared/kbn-doc-links/tsconfig.json:2\r\nsrc/platform/packages/shared/kbn-doc-links/tsconfig.type_check.json:2\r\n```\r\n</details>\r\n<details>\r\n<summary>Script
errors</summary>\r\n\r\n```\r\n\r\n```\r\n</details>","sha":"b2d49b8beb1d92bc2af45f67c6170bc58f26cec9"}}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <[email protected]>
  • Loading branch information
gsoldevila and kibanamachine authored Dec 9, 2024
1 parent a662580 commit 61dfcaa
Show file tree
Hide file tree
Showing 16 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ x-pack/plugins/discover_enhanced @elastic/kibana-data-discovery
src/plugins/discover @elastic/kibana-data-discovery
src/plugins/discover_shared @elastic/kibana-data-discovery @elastic/obs-ux-logs-team
packages/kbn-discover-utils @elastic/kibana-data-discovery
packages/kbn-doc-links @elastic/docs
src/platform/packages/shared/kbn-doc-links @elastic/docs
packages/kbn-docs-utils @elastic/kibana-operations
packages/kbn-dom-drag-drop @elastic/kibana-visualizations @elastic/kibana-data-discovery
packages/kbn-ebt-tools @elastic/kibana-core
Expand Down
4 changes: 2 additions & 2 deletions docs/upgrade-notes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ ADD INSTRUCTIONS FOR USERS LOOKING TO UPGRADE. HOW CAN THEY WORK AROUND THIS?
1. Copy and edit the template in the right area section of this file. Most recent entries should be at the top of the section.
2. Edit the anchor ID [[REPO-PR]] of the template with proper values.
3. Don't hardcode the link to the new entry. Instead, make it available through the doc link service files:
- https://github.com/elastic/kibana/blob/main/packages/kbn-doc-links/src/get_doc_links.ts
- https://github.com/elastic/kibana/blob/main/packages/kbn-doc-links/src/types.ts
- https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
- https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-doc-links/src/types.ts
The entry in the main links file should look like this:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@
"@kbn/discover-plugin": "link:src/plugins/discover",
"@kbn/discover-shared-plugin": "link:src/plugins/discover_shared",
"@kbn/discover-utils": "link:packages/kbn-discover-utils",
"@kbn/doc-links": "link:packages/kbn-doc-links",
"@kbn/doc-links": "link:src/platform/packages/shared/kbn-doc-links",
"@kbn/dom-drag-drop": "link:packages/kbn-dom-drag-drop",
"@kbn/ebt-tools": "link:packages/kbn-ebt-tools",
"@kbn/ecs-data-quality-dashboard": "link:x-pack/packages/security-solution/ecs_data_quality_dashboard",
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@

module.exports = {
preset: '@kbn/test',
rootDir: '../..',
roots: ['<rootDir>/packages/kbn-doc-links'],
rootDir: '../../../../..',
roots: ['<rootDir>/src/platform/packages/shared/kbn-doc-links'],
};
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"extends": "../../tsconfig.base.json",
"extends": "../../../../../tsconfig.base.json",
"compilerOptions": {
"outDir": "target/types",
"types": [
Expand Down
4 changes: 2 additions & 2 deletions tsconfig.base.json
Original file line number Diff line number Diff line change
Expand Up @@ -784,8 +784,8 @@
"@kbn/discover-shared-plugin/*": ["src/plugins/discover_shared/*"],
"@kbn/discover-utils": ["packages/kbn-discover-utils"],
"@kbn/discover-utils/*": ["packages/kbn-discover-utils/*"],
"@kbn/doc-links": ["packages/kbn-doc-links"],
"@kbn/doc-links/*": ["packages/kbn-doc-links/*"],
"@kbn/doc-links": ["src/platform/packages/shared/kbn-doc-links"],
"@kbn/doc-links/*": ["src/platform/packages/shared/kbn-doc-links/*"],
"@kbn/docs-utils": ["packages/kbn-docs-utils"],
"@kbn/docs-utils/*": ["packages/kbn-docs-utils/*"],
"@kbn/dom-drag-drop": ["packages/kbn-dom-drag-drop"],
Expand Down
2 changes: 1 addition & 1 deletion yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -5375,7 +5375,7 @@
version "0.0.0"
uid ""

"@kbn/doc-links@link:packages/kbn-doc-links":
"@kbn/doc-links@link:src/platform/packages/shared/kbn-doc-links":
version "0.0.0"
uid ""

Expand Down

0 comments on commit 61dfcaa

Please sign in to comment.