docs(NA): adding @kbn/ambient-storybook-types into ops docs (elastic#…

…132483)
pmuellr · May 18, 2022 · d8a6258 · d8a6258
1 parent b29c645
commit d8a6258
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 4 deletions.
diff --git a/dev_docs/operations/operations_landing.mdx b/dev_docs/operations/operations_landing.mdx
@@ -43,6 +43,7 @@ layout: landing
     { pageId: "kibDevDocsToolingLog" },
     { pageId: "kibDevDocsOpsJestSerializers"},
     { pageId: "kibDevDocsOpsExpect" },
+    { pageId: "kibDevDocsOpsAmbientStorybookTypes" },
     { pageId: "kibDevDocsOpsAmbientUiTypes"},
   ]}
 />
diff --git a/nav-kibana-dev.docnav.json b/nav-kibana-dev.docnav.json
@@ -197,8 +197,9 @@
           "label": "Utilities",
           "items": [
             { "id": "kibDevDocsToolingLog" },
-            { "id": "kibDevDocsOpsJestSerializers"},
+            { "id": "kibDevDocsOpsJestSerializers" },
             { "id": "kibDevDocsOpsExpect" },
+            { "id": "kibDevDocsOpsAmbientStorybookTypes" },
             { "id": "kibDevDocsOpsAmbientUiTypes" }
           ]
         }

diff --git a/packages/kbn-ambient-storybook-types/README.md b/packages/kbn-ambient-storybook-types/README.md
diff --git a/packages/kbn-ambient-storybook-types/README.mdx b/packages/kbn-ambient-storybook-types/README.mdx
@@ -0,0 +1,18 @@
+---
+id: kibDevDocsOpsAmbientStorybookTypes
+slug: /kibana-dev-docs/ops/ambient-storybook-types
+title: "@kbn/ambient-storybook-types"
+description: A package holding ambient type definitions for storybooks
+date: 2022-05-18
+tags: ['kibana', 'dev', 'contributor', 'operations', 'ambient', 'storybook', 'types']
+---
+
+This package holds ambient typescript definitions needed to use storybooks.
+
+## Packages
+
+To include these types in a package:
+
+- add `"//packages/kbn-ambient-storybook-types"` to the `RUNTIME_DEPS` portion of the `BUILD.bazel` file.
+- add `"//packages/kbn-ambient-storybook-types:npm_module_types"` to the `TYPES_DEPS` portion of the `BUILD.bazel` file.
+- add `"@kbn/ambient-storybook-types"` to the `types` portion of the `tsconfig.json` file.