From ae6615afc0adabf70ad96d7762a122c72f910c84 Mon Sep 17 00:00:00 2001 From: adamviktora Date: Wed, 9 Oct 2024 10:15:25 +0200 Subject: [PATCH] docs: DeleteModal updates --- .../content/design-guidelines/design-guidelines.md | 2 +- .../content/examples/{basic.md => DeleteModal.md} | 12 ++---------- .../module/patternfly-docs/patternfly-docs.config.js | 2 +- .../module/patternfly-docs/patternfly-docs.source.js | 2 +- 4 files changed, 5 insertions(+), 13 deletions(-) rename packages/module/patternfly-docs/content/examples/{basic.md => DeleteModal.md} (54%) diff --git a/packages/module/patternfly-docs/content/design-guidelines/design-guidelines.md b/packages/module/patternfly-docs/content/design-guidelines/design-guidelines.md index 3d6fcf3..d8bb2f3 100644 --- a/packages/module/patternfly-docs/content/design-guidelines/design-guidelines.md +++ b/packages/module/patternfly-docs/content/design-guidelines/design-guidelines.md @@ -1,7 +1,7 @@ --- # Sidenav top-level section # should be the same for all markdown files for each extension -section: extensions +section: AI-infra-ui-components # Sidenav secondary level section # should be the same for all markdown files for each extension id: DeleteModal diff --git a/packages/module/patternfly-docs/content/examples/basic.md b/packages/module/patternfly-docs/content/examples/DeleteModal.md similarity index 54% rename from packages/module/patternfly-docs/content/examples/basic.md rename to packages/module/patternfly-docs/content/examples/DeleteModal.md index 47959df..7c96ae0 100644 --- a/packages/module/patternfly-docs/content/examples/basic.md +++ b/packages/module/patternfly-docs/content/examples/DeleteModal.md @@ -1,7 +1,7 @@ --- # Sidenav top-level section # should be the same for all markdown files -section: extensions +section: AI-infra-ui-components # Sidenav secondary level section # should be the same for all markdown files id: DeleteModal @@ -14,18 +14,10 @@ propComponents: ['DeleteModal'] import { DeleteModal } from "@patternfly/ai-infra-ui-components"; -Note: this component is an upgrade of an [existing DeleteModal](https://github.com/opendatahub-io/odh-dashboard/blob/main/frontend/src/pages/projects/components/DeleteModal.tsx) in odh-dashboard - -## Basic usage +Note: this component documents the API and enhances the [existing DeleteModal](https://github.com/opendatahub-io/odh-dashboard/blob/main/frontend/src/pages/projects/components/DeleteModal.tsx) component from odh-dashboard. It can be imported from [@patternfly/ai-infra-ui-components](https://www.npmjs.com/package/@patternfly/AI-infra-ui-components). Alternatively, it can be used within the odh-dashboard via the import: `~/pages/projects/components/DeleteModal` ### Example ```js file="./DeleteModalBasic.tsx" ``` - -### Fullscreen example - -```js file="./DeleteModalBasic.tsx" isFullscreen - -``` diff --git a/packages/module/patternfly-docs/patternfly-docs.config.js b/packages/module/patternfly-docs/patternfly-docs.config.js index 7a4cdb6..4db7142 100644 --- a/packages/module/patternfly-docs/patternfly-docs.config.js +++ b/packages/module/patternfly-docs/patternfly-docs.config.js @@ -1,6 +1,6 @@ // This module is shared between NodeJS and babelled ES5 module.exports = { - sideNavItems: [{ section: 'extensions' }], + sideNavItems: [{ section: 'AI-infra-ui-components' }], topNavItems: [], port: 8006 }; diff --git a/packages/module/patternfly-docs/patternfly-docs.source.js b/packages/module/patternfly-docs/patternfly-docs.source.js index 5ae9c80..e1b1ab0 100644 --- a/packages/module/patternfly-docs/patternfly-docs.source.js +++ b/packages/module/patternfly-docs/patternfly-docs.source.js @@ -8,7 +8,7 @@ module.exports = (sourceMD, sourceProps) => { // Parse md files const contentBase = path.join(__dirname, './content'); - sourceMD(path.join(contentBase, '/**/*.md'), 'extensions'); + sourceMD(path.join(contentBase, '/**/*.md'), 'AI-infra-ui-components'); /** If you want to parse content from node_modules instead of providing a relative/absolute path,