docs(react-component-groups): Creates overview page for extension. #81
Conversation
packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md
Outdated
Show resolved
Hide resolved
packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md
Show resolved
Hide resolved
packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
This looks good so far, but it seems a little bare at the moment. Some other things that could be good to add are:
- Some kind of getting started with this repo - what are some of the basics that a user would have to know in order to use component groups? The extensions that do have something similar to an About page typically help give the user general background info on how to use it. Ex: Quick Starts and Topology (@dlabaj maybe you can help suggest something for this? Doesn't have to be anything super complex, just wondering what are the basics a user needs to know to get started using it.)
- Contributing to the repo - How do others contribute to the repo? Perhaps we can make a note about where to go to in order to create issues. Do we have any expectations for those wanting to contribute?
- Standards of this repo - since this extension is one of the first, genuine collaborations with a team when it comes to contributions, I'm wondering if perhaps we should make some mention of the standards. (Other extensions were often pulled from products as well, but PF took full control once it was an extension. This extension has felt far more collaborative as we've been working closely with HCC. Because of that, we're trying to be a little flexible but still hold it to PF standards.)
Co-authored-by: Erin Donehoo <[email protected]>
|
|
||
| The **patternfly/react-component-groups** extension contains a range of React components that are more complex than basic PatternFly components, often combining and adjusting multiple base components to address common use cases. | ||
|
|
||
| This extension replaces **RedHatInsights/frontend-components**. To migrate your product to this new implementation, you can refer to migration guide details in [the README in the React component groups repository](https://github.com/patternfly/react-component-groups/migration.md). |
There was a problem hiding this comment.
We could add the following describing imports.
Direct Imports
React component groups supports direct imports. This is useful in improving your bundle size. To directly import a component your import should look similar to the following:
import Ansible from '@patternfly/react-component-groups/dist/dynamic/Ansible';
Alternatively could use a plugin to change relative imports to direct imports. Direct imports are specifically important when using module federation in webpack. To learn more about the importance importing has on your bundle size see the following article:
Webpack module federation think twice before sharing a dependency
|
I think at the top of this page, it should make it clear that the components in this section are coming from the @patternfly/react-component-groups package and link to this NPM page: https://www.npmjs.com/package/@patternfly/react-component-groups It should also highlight that the code for these components lives in the following repo: https://github.com/patternfly/react-component-groups |
packages/module/patternfly-docs/content/extensions/component-groups/about-component-groups.md
Outdated
Show resolved
Hide resolved
|
Does the "sortValue" param work at this nav level? |
|
🎉 This PR is included in version 5.0.0-prerelease.10 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
yeah - adding |
|
@nicolethoen I haven't able to get my local build to work for this repo, so I'm not sure 😅 |
Closes #79