[ES|QL] Renames the language package to a more generic name (#193517)

## Summary Renames the language-documentation-popover to language-documentation as it stores additional layouts: - popover - flyout - inline
elastic · Sep 23, 2024 · 9d0d41c · 9d0d41c
1 parent 1d27973
commit 9d0d41c
Show file tree

Hide file tree

Showing 46 changed files with 1,236 additions and 1,345 deletions.
diff --git a/.buildkite/scripts/steps/esql_generate_function_metadata.sh b/.buildkite/scripts/steps/esql_generate_function_metadata.sh
@@ -2,7 +2,7 @@
 set -euo pipefail
 
 VALIDATION_PACKAGE_DIR="packages/kbn-esql-validation-autocomplete"
-EDITOR_PACKAGE_DIR="packages/kbn-language-documentation-popover"
+EDITOR_PACKAGE_DIR="packages/kbn-language-documentation"
 GIT_SCOPE="$VALIDATION_PACKAGE_DIR/**/* $EDITOR_PACKAGE_DIR/**/*"
 
 report_main_step () {

diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -553,7 +553,7 @@ src/plugins/kibana_usage_collection @elastic/kibana-core
 src/plugins/kibana_utils @elastic/appex-sharedux
 x-pack/plugins/kubernetes_security @elastic/kibana-cloud-security-posture
 x-pack/packages/kbn-langchain @elastic/security-generative-ai
-packages/kbn-language-documentation-popover @elastic/kibana-esql
+packages/kbn-language-documentation @elastic/kibana-esql
 x-pack/examples/lens_config_builder_example @elastic/kibana-visualizations
 packages/kbn-lens-embeddable-utils @elastic/obs-ux-infra_services-team @elastic/kibana-visualizations
 packages/kbn-lens-formula-docs @elastic/kibana-visualizations

diff --git a/.i18nrc.json b/.i18nrc.json
@@ -118,7 +118,7 @@
     "serverlessPackages": "packages/serverless",
     "sse": [ "packages/kbn-sse-utils" ],
     "coloring": "packages/kbn-coloring/src",
-    "languageDocumentationPopover": "packages/kbn-language-documentation-popover/src",
+    "languageDocumentation": "packages/kbn-language-documentation/src",
     "esql": "src/plugins/esql",
     "esqlDataGrid": "src/plugins/esql_datagrid",
     "statusPage": "src/legacy/core_plugins/status_page",

diff --git a/package.json b/package.json
@@ -593,7 +593,7 @@
     "@kbn/kibana-utils-plugin": "link:src/plugins/kibana_utils",
     "@kbn/kubernetes-security-plugin": "link:x-pack/plugins/kubernetes_security",
     "@kbn/langchain": "link:x-pack/packages/kbn-langchain",
-    "@kbn/language-documentation-popover": "link:packages/kbn-language-documentation-popover",
+    "@kbn/language-documentation": "link:packages/kbn-language-documentation",
     "@kbn/lens-config-builder-example-plugin": "link:x-pack/examples/lens_config_builder_example",
     "@kbn/lens-embeddable-utils": "link:packages/kbn-lens-embeddable-utils",
     "@kbn/lens-formula-docs": "link:packages/kbn-lens-formula-docs",

diff --git a/...-documentation-popover/.storybook/main.js → ...language-documentation/.storybook/main.js b/...-documentation-popover/.storybook/main.js → ...language-documentation/.storybook/main.js
diff --git a/...-language-documentation-popover/README.md → ...ages/kbn-language-documentation/README.md b/...-language-documentation-popover/README.md → ...ages/kbn-language-documentation/README.md
@@ -1,15 +1,29 @@
-### Shareable language documentation popover
+### Shareable language documentation
 
-This is a stateless shareable component that can be used to render documentation for a language as a popover.
+This is a stateless shareable component that can be used to render documentation for a language as a popover, flyour or a React component that you can add in your applications as you wish.
 
 It can be used in every application that would like to add an in-app documentation. The component consists of:
 - A sidebar navigation with a search
 - A details page
 
+### As a popover (currently used for Lens formulas)
+
 ```
 <LanguageDocumentationPopover language={language} sections={documentationSections} onHelpMenuVisibilityChange={onHelpMenuVisibilityChange} isHelpMenuOpen={isHelpMenuOpen} />
 ```
 
+### As a flyout (currently used for ES|QL in unified search)
+
+```
+<LanguageDocumentationFlyout linkToDocumentation={docLinks?.links?.query?.queryESQL ?? ''} isHelpMenuOpen={isLanguageComponentOpen} onHelpMenuVisibilityChange={setIsLanguageComponentOpen} />
+```
+
+### As an inline component (currently used for ES|QL in Lens inline editing, alerts)
+
+```
+<LanguageDocumentationInline />
+```
+
 The properties are typed as:
 
 ```

diff --git a/...n-language-documentation-popover/index.ts → packages/kbn-language-documentation/index.ts b/...n-language-documentation-popover/index.ts → packages/kbn-language-documentation/index.ts
diff --git a/...uage-documentation-popover/jest.config.js → ...kbn-language-documentation/jest.config.js b/...uage-documentation-popover/jest.config.js → ...kbn-language-documentation/jest.config.js
@@ -10,5 +10,5 @@
 module.exports = {
   preset: '@kbn/test',
   rootDir: '../..',
-  roots: ['<rootDir>/packages/kbn-language-documentation-popover'],
+  roots: ['<rootDir>/packages/kbn-language-documentation'],
 };
diff --git a/...nguage-documentation-popover/kibana.jsonc → ...s/kbn-language-documentation/kibana.jsonc b/...nguage-documentation-popover/kibana.jsonc → ...s/kbn-language-documentation/kibana.jsonc
@@ -1,5 +1,5 @@
 {
   "type": "shared-common",
-  "id": "@kbn/language-documentation-popover",
+  "id": "@kbn/language-documentation",
   "owner": "@elastic/kibana-esql"
 }
diff --git a/...nguage-documentation-popover/package.json → ...s/kbn-language-documentation/package.json b/...nguage-documentation-popover/package.json → ...s/kbn-language-documentation/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@kbn/language-documentation-popover",
+  "name": "@kbn/language-documentation",
   "version": "1.0.0",
   "license": "Elastic License 2.0 OR AGPL-3.0-only OR SSPL-1.0",
   "private": true,
@@ -9,6 +9,6 @@
   "scripts": {
     "make:docs": "ts-node --transpileOnly scripts/generate_esql_docs.ts",
     "postmake:docs": "yarn run lint:fix",
-    "lint:fix": "cd ../.. && node ./scripts/eslint --fix ./packages/kbn-language-documentation-popover/src/sections/generated"
+    "lint:fix": "cd ../.. && node ./scripts/eslint --fix ./packages/kbn-language-documentation/src/sections/generated"
   }
 }
diff --git a/...ion-popover/scripts/generate_esql_docs.ts → ...cumentation/scripts/generate_esql_docs.ts b/...ion-popover/scripts/generate_esql_docs.ts → ...cumentation/scripts/generate_esql_docs.ts
@@ -86,7 +86,7 @@ function writeFunctionDocs(functionDocs: Map<string, string>, pathToDocsFile: st
   // Do not edit manually... automatically generated by scripts/generate_esql_docs.ts
   {
     label: i18n.translate(
-      'languageDocumentationPopover.documentationESQL.${name}',
+      'languageDocumentation.documentationESQL.${name}',
       {
         defaultMessage: '${name.toUpperCase()}',
       }
@@ -97,7 +97,7 @@ function writeFunctionDocs(functionDocs: Map<string, string>, pathToDocsFile: st
         readOnly
         enableSoftLineBreaks
         markdownContent={i18n.translate(
-          'languageDocumentationPopover.documentationESQL.${name}.markdown',
+          'languageDocumentation.documentationESQL.${name}.markdown',
           {
             defaultMessage: \`${docWithoutLinks.replaceAll('`', '\\`')}\`,
             description:

diff --git a/...uage-documentation-popover/setup_tests.ts → ...kbn-language-documentation/setup_tests.ts b/...uage-documentation-popover/setup_tests.ts → ...kbn-language-documentation/setup_tests.ts
diff --git a/...anguage_documentation_popover.stories.tsx → ...anguage_documentation_popover.stories.tsx b/...anguage_documentation_popover.stories.tsx → ...anguage_documentation_popover.stories.tsx
diff --git a/...r/src/components/as_flyout/index.test.tsx → ...n/src/components/as_flyout/index.test.tsx b/...r/src/components/as_flyout/index.test.tsx → ...n/src/components/as_flyout/index.test.tsx
diff --git a/...opover/src/components/as_flyout/index.tsx → ...tation/src/components/as_flyout/index.tsx b/...opover/src/components/as_flyout/index.tsx → ...tation/src/components/as_flyout/index.tsx
@@ -85,7 +85,7 @@ function DocumentationFlyout({
           <EuiFlyoutHeader hasBorder>
             <EuiTitle size="s">
               <h3>
-                {i18n.translate('languageDocumentationPopover.documentationFlyoutTitle', {
+                {i18n.translate('languageDocumentation.documentationFlyoutTitle', {
                   defaultMessage: 'ES|QL quick reference',
                 })}
               </h3>

diff --git a/...r/src/components/as_inline/index.test.tsx → ...n/src/components/as_inline/index.test.tsx b/...r/src/components/as_inline/index.test.tsx → ...n/src/components/as_inline/index.test.tsx
diff --git a/...opover/src/components/as_inline/index.tsx → ...tation/src/components/as_inline/index.tsx b/...opover/src/components/as_inline/index.tsx → ...tation/src/components/as_inline/index.tsx
diff --git a/.../components/as_popover/documentation.scss → .../components/as_popover/documentation.scss b/.../components/as_popover/documentation.scss → .../components/as_popover/documentation.scss
diff --git a/...pover/src/components/as_popover/index.tsx → ...ation/src/components/as_popover/index.tsx b/...pover/src/components/as_popover/index.tsx → ...ation/src/components/as_popover/index.tsx
@@ -60,7 +60,7 @@ function DocumentationPopover({
         button={
           <EuiToolTip
             position="top"
-            content={i18n.translate('languageDocumentationPopover.tooltip', {
+            content={i18n.translate('languageDocumentation.tooltip', {
               defaultMessage: '{lang} reference',
               values: {
                 lang: language,

diff --git a/...nents/as_popover/popover_content.test.tsx → ...nents/as_popover/popover_content.test.tsx b/...nents/as_popover/popover_content.test.tsx → ...nents/as_popover/popover_content.test.tsx
diff --git a/...components/as_popover/popover_content.tsx → ...components/as_popover/popover_content.tsx b/...components/as_popover/popover_content.tsx → ...components/as_popover/popover_content.tsx
@@ -70,15 +70,15 @@ function DocumentationContent({
           justifyContent="spaceBetween"
         >
           <EuiFlexItem grow={false}>
-            {i18n.translate('languageDocumentationPopover.header', {
+            {i18n.translate('languageDocumentation.header', {
               defaultMessage: '{language} reference',
               values: { language },
             })}
           </EuiFlexItem>
           {linkToDocumentation && (
             <EuiFlexItem grow={false}>
               <EuiLink external href={linkToDocumentation} target="_blank">
-                {i18n.translate('languageDocumentationPopover.documentationLinkLabel', {
+                {i18n.translate('languageDocumentation.documentationLinkLabel', {
                   defaultMessage: 'View full documentation',
                 })}
               </EuiLink>
@@ -106,7 +106,7 @@ function DocumentationContent({
                   setSearchText(e.target.value);
                 }}
                 data-test-subj="language-documentation-navigation-search"
-                placeholder={i18n.translate('languageDocumentationPopover.searchPlaceholder', {
+                placeholder={i18n.translate('languageDocumentation.searchPlaceholder', {
                   defaultMessage: 'Search',
                 })}
               />

diff --git a/...mponents/shared/documentation_content.tsx → ...mponents/shared/documentation_content.tsx b/...mponents/shared/documentation_content.tsx → ...mponents/shared/documentation_content.tsx
diff --git a/...nents/shared/documentation_navigation.tsx → ...nents/shared/documentation_navigation.tsx b/...nents/shared/documentation_navigation.tsx → ...nents/shared/documentation_navigation.tsx
@@ -45,7 +45,7 @@ function DocumentationNav({
         <EuiFlexItem grow={true}>
           <EuiFormRow
             fullWidth
-            label={i18n.translate('languageDocumentationPopover.esqlDocsLabel', {
+            label={i18n.translate('languageDocumentation.esqlDocsLabel', {
               defaultMessage: 'Select or search topics',
             })}
             labelAppend={
@@ -57,7 +57,7 @@ function DocumentationNav({
                     target="_blank"
                     data-test-subj="language-documentation-navigation-link"
                   >
-                    {i18n.translate('languageDocumentationPopover.esqlDocsLinkLabel', {
+                    {i18n.translate('languageDocumentation.esqlDocsLinkLabel', {
                       defaultMessage: 'View full ES|QL documentation',
                     })}
                   </EuiLink>
@@ -66,10 +66,10 @@ function DocumentationNav({
             }
           >
             <EuiComboBox
-              aria-label={i18n.translate('languageDocumentationPopover.navigationAriaLabel', {
+              aria-label={i18n.translate('languageDocumentation.navigationAriaLabel', {
                 defaultMessage: 'Navigate through the documentation',
               })}
-              placeholder={i18n.translate('languageDocumentationPopover.navigationPlaceholder', {
+              placeholder={i18n.translate('languageDocumentation.navigationPlaceholder', {
                 defaultMessage: 'Commands and functions',
               })}
               data-test-subj="language-documentation-navigation-dropdown"
@@ -94,7 +94,7 @@ function DocumentationNav({
               setSearchText(e.target.value);
             }}
             data-test-subj="language-documentation-navigation-search"
-            placeholder={i18n.translate('languageDocumentationPopover.searchPlaceholder', {
+            placeholder={i18n.translate('languageDocumentation.searchPlaceholder', {
               defaultMessage: 'Search',
             })}
             fullWidth

diff --git a/...on-popover/src/components/shared/index.ts → ...umentation/src/components/shared/index.ts b/...on-popover/src/components/shared/index.ts → ...umentation/src/components/shared/index.ts