From 87dd01df76c31ecb3e2604ec039e99677de67090 Mon Sep 17 00:00:00 2001 From: Filip Hlavac Date: Thu, 10 Oct 2024 23:56:03 +0200 Subject: [PATCH 1/4] fix(nav): Fix ResponsiveActions displaying --- .../examples/ResponsiveActions/ResponsiveActions.md | 4 ++-- yarn.lock | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/module/patternfly-docs/content/extensions/component-groups/examples/ResponsiveActions/ResponsiveActions.md b/packages/module/patternfly-docs/content/extensions/component-groups/examples/ResponsiveActions/ResponsiveActions.md index 35e80be8..433d1509 100644 --- a/packages/module/patternfly-docs/content/extensions/component-groups/examples/ResponsiveActions/ResponsiveActions.md +++ b/packages/module/patternfly-docs/content/extensions/component-groups/examples/ResponsiveActions/ResponsiveActions.md @@ -1,8 +1,8 @@ --- # Sidenav top-level section # should be the same for all markdown files -section: extensions -subsection: Component groups +section: Component groups +subsection: Controls # Sidenav secondary level section # should be the same for all markdown files id: Responsive actions diff --git a/yarn.lock b/yarn.lock index df992ad0..99a5a21b 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1760,9 +1760,9 @@ version "5.0.0-prerelease.0" resolved "file:packages/module" dependencies: - "@patternfly/react-core" "^6.0.0-alpha.101" - "@patternfly/react-icons" "^6.0.0-alpha.36" - "@patternfly/react-table" "^6.0.0-alpha.102" + "@patternfly/react-core" "^6.0.0-prerelease.21" + "@patternfly/react-icons" "^6.0.0-prerelease.7" + "@patternfly/react-table" "^6.0.0-prerelease.22" clsx "^2.1.1" react-jss "^10.10.0" From 5465d4b7626be8d4d6c70f12cc4d15db13639fa6 Mon Sep 17 00:00:00 2001 From: Filip Hlavac Date: Thu, 10 Oct 2024 23:56:18 +0200 Subject: [PATCH 2/4] fix(gallery): Add gallery to the about page --- .../about-component-groups.md | 19 ++++++++++++++++--- .../component-groups/gallery-data.json | 17 +++++++++++++++++ 2 files changed, 33 insertions(+), 3 deletions(-) create mode 100644 packages/module/patternfly-docs/content/extensions/component-groups/gallery-data.json diff --git a/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md b/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md index f1050f64..c7af1a16 100644 --- a/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md +++ b/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md @@ -4,14 +4,27 @@ id: About component groups sortValue: 1 sourceLink: https://github.com/patternfly/react-component-groups/blob/main/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md --- +import { SectionGallery } from '@patternfly/documentation-framework/components/sectionGallery/sectionGallery'; +import galleryData from './gallery-data.json'; Component groups lives in its own package [`@patternfly/react-component-groups`](https://www.npmjs.com/package/@patternfly/react-component-groups) # Component groups -The component groups extension contains a range of React components that are more complex than basic PatternFly components. These component groups combine and adjust multiple base components to provide opinionated solutions for recurring use cases across products using PatternFly. +The component groups extension contains a range of React components that are more complex than basic PatternFly components. These component groups combine and adjust multiple base components to provide opinionated solutions for recurring use cases across products using PatternFly. -The creation and maintenance of this extension is a collaborative effort between the PatternFly and Red Hat Hybrid Cloud Console teams. All component groups receive accessibility and design reviews, and we are working to improve internationalization, add unit test coverage, and ensure that CSS overrides all correctly reference the PatternFly CSS API. +The creation and maintenance of this extension is a collaborative effort between the PatternFly and Red Hat Hybrid Cloud Console teams. All component groups receive accessibility and design reviews, and we are working to improve internationalization, add test coverage, and ensure that CSS overrides all correctly reference the PatternFly CSS API. + +Below, you can see a gallery of categories representing the components: + + **Note:** This extension replaces [`RedHatInsights/frontend-components`](https://github.com/RedHatInsights/frontend-components). If you previoulsy used `frontend-components`, you can refer to [this migration guide](https://github.com/patternfly/react-component-groups/blob/main/migration.md) to help you transition to `react-component-groups`. @@ -25,4 +38,4 @@ Specific contribution guidelines and instructions are outlined in [the component We aim to align the standards of component groups as closely as possible with existing PatternFly standards. Given that this is a multi-team collaboration, we will continue to work towards this goal together. -If you notice a bug or have a suggestion for a new component group, feel free to file an issue in our [GitHub repository](https://github.com/patternfly/react-component-groups/issues)! Please make sure to check if there is already a pre-existing issue before creating a new issue. +If you notice a bug or have a suggestion for a new component group, open an issue in our [GitHub repository](https://github.com/patternfly/react-component-groups/issues)! Please make sure to check if there is already a pre-existing issue before creating a new one. diff --git a/packages/module/patternfly-docs/content/extensions/component-groups/gallery-data.json b/packages/module/patternfly-docs/content/extensions/component-groups/gallery-data.json new file mode 100644 index 00000000..16af21ef --- /dev/null +++ b/packages/module/patternfly-docs/content/extensions/component-groups/gallery-data.json @@ -0,0 +1,17 @@ +{ + "content-containers": { + "summary": "Provide layout components to organize and display content in structured and flexible formats." + }, + "controls": { + "summary": "Include components that manage user interactions and input, enabling intuitive navigation and selection." + }, + "error-communication": { + "summary": "Contain various error and alert states to communicate issues or restrictions." + }, + "helpers": { + "summary": "Offer utility components that enhance usability and provide additional guidance or information within the UI." + }, + "status-and-state-indicators": { + "summary": "Visualize entity states, statuses, and loading indicators to inform users of system conditions or processes." + } + } \ No newline at end of file From 2cfcb318178904559af94f8df46b4c818767ca46 Mon Sep 17 00:00:00 2001 From: Filip Hlavac Date: Mon, 14 Oct 2024 11:44:18 +0200 Subject: [PATCH 3/4] fix(gallery): Adress review notes --- .../component-groups/about-component-groups.md | 6 +++--- .../extensions/component-groups/gallery-data.json | 10 +++++----- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md b/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md index c7af1a16..5216bb78 100644 --- a/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md +++ b/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md @@ -9,13 +9,15 @@ import galleryData from './gallery-data.json'; Component groups lives in its own package [`@patternfly/react-component-groups`](https://www.npmjs.com/package/@patternfly/react-component-groups) +**Note:** This extension replaces [`RedHatInsights/frontend-components`](https://github.com/RedHatInsights/frontend-components). If you previoulsy used `frontend-components`, you can refer to [this migration guide](https://github.com/patternfly/react-component-groups/blob/main/migration.md) to help you transition to `react-component-groups`. + # Component groups The component groups extension contains a range of React components that are more complex than basic PatternFly components. These component groups combine and adjust multiple base components to provide opinionated solutions for recurring use cases across products using PatternFly. The creation and maintenance of this extension is a collaborative effort between the PatternFly and Red Hat Hybrid Cloud Console teams. All component groups receive accessibility and design reviews, and we are working to improve internationalization, add test coverage, and ensure that CSS overrides all correctly reference the PatternFly CSS API. -Below, you can see a gallery of categories representing the components: +There are a few different functional categories of component groups: -**Note:** This extension replaces [`RedHatInsights/frontend-components`](https://github.com/RedHatInsights/frontend-components). If you previoulsy used `frontend-components`, you can refer to [this migration guide](https://github.com/patternfly/react-component-groups/blob/main/migration.md) to help you transition to `react-component-groups`. - ## Contribution guidelines The code for component groups lives in the [`patternfly/react-component-groups repository`](https://github.com/patternfly/react-component-groups). diff --git a/packages/module/patternfly-docs/content/extensions/component-groups/gallery-data.json b/packages/module/patternfly-docs/content/extensions/component-groups/gallery-data.json index 16af21ef..2ed8dad9 100644 --- a/packages/module/patternfly-docs/content/extensions/component-groups/gallery-data.json +++ b/packages/module/patternfly-docs/content/extensions/component-groups/gallery-data.json @@ -1,17 +1,17 @@ { "content-containers": { - "summary": "Provide layout components to organize and display content in structured and flexible formats." + "summary": "Organize and display information in structured or flexible containers." }, "controls": { - "summary": "Include components that manage user interactions and input, enabling intuitive navigation and selection." + "summary": "Enable more effective navigation and selection by providing users with options for interaction and input." }, "error-communication": { - "summary": "Contain various error and alert states to communicate issues or restrictions." + "summary": "Communicate issues or restrictions through error and alert states." }, "helpers": { - "summary": "Offer utility components that enhance usability and provide additional guidance or information within the UI." + "summary": "Provide users with utilities that enhance usability and provide additional guidance or information within the UI." }, "status-and-state-indicators": { - "summary": "Visualize entity states, statuses, and loading indicators to inform users of system conditions or processes." + "summary": "Inform users of system conditions or processes through visualizations of entity states, statuses, and loading indicators." } } \ No newline at end of file From e10f1ddd670ffae4e8a9e1a7897f778e355cdf58 Mon Sep 17 00:00:00 2001 From: Filip Hlavac <50696716+fhlavac@users.noreply.github.com> Date: Mon, 14 Oct 2024 15:04:00 +0200 Subject: [PATCH 4/4] Update packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com> --- .../extensions/component-groups/about-component-groups.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md b/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md index 5216bb78..fa0f15bf 100644 --- a/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md +++ b/packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md @@ -9,7 +9,7 @@ import galleryData from './gallery-data.json'; Component groups lives in its own package [`@patternfly/react-component-groups`](https://www.npmjs.com/package/@patternfly/react-component-groups) -**Note:** This extension replaces [`RedHatInsights/frontend-components`](https://github.com/RedHatInsights/frontend-components). If you previoulsy used `frontend-components`, you can refer to [this migration guide](https://github.com/patternfly/react-component-groups/blob/main/migration.md) to help you transition to `react-component-groups`. +**Note:** This extension replaces [`RedHatInsights/frontend-components`](https://github.com/RedHatInsights/frontend-components). If you previously used `frontend-components`, you can refer to [this migration guide](https://github.com/patternfly/react-component-groups/blob/main/migration.md) to help you transition to `react-component-groups`. # Component groups