diff --git a/packages/documentation-site/patternfly-docs/content/get-help/contact-us.md b/packages/documentation-site/patternfly-docs/content/get-help/contact-us.md new file mode 100644 index 0000000000..c8c0ab551d --- /dev/null +++ b/packages/documentation-site/patternfly-docs/content/get-help/contact-us.md @@ -0,0 +1,30 @@ +--- +id: Contact us +section: get-help +--- + +The PatternFly team is available to help answer any questions that you can't find the answer to on our website. There are a couple of ways to get in touch with our team quickly. + +## Before you reach out, check out our resources + +We eagerly welcome Flyers to reach out to us and start discussions, but it's a great first step to explore our resources and search our comprehensive website documentation for answers to your questions. + +In addition to the detailed design guidelines you can find on our website for components, extensions, patterns, and foundational practices, we publish answers to frequently asked questions in [our FAQs guide.](/get-help/faqs). While we can't predict every question you may have, this guide addresses some of the most common ones. + +## Join our office hours + +Every two weeks, the PatternFly team sets aside time to address any questions or issues presented by Flyers in our design and development office hours. To keep track of our meeting schedule, [add our Google Calendar to yours](https://calendar.google.com/calendar/embed?src=patternflyteam%40gmail.com&ctz=America%2FNew_York). + +Any PatternFly-related topic is welcome at this meeting, where you can directly talk face to face with the team that builds and maintains PatternFly. Topics often include questions specific to a design and development challenge, with many attendees presenting in-progress work for feedback. + +If there's something you'd like to discuss in this meeting, [sign up for a topic in advance](https://docs.google.com/document/d/16ltdRXX4U-FLunZpPdmQjATZHUTxjyTh-BGsoqdFKTs/edit?tab=t.0#heading=h.fdgi7w700vmz), so that we can plan ahead and predict the amount of time each topic will take. If you have something to share at this meeting, but you can't make it, you can have someone else come and present on your behalf. + +## Reach out to the team + +The best way to reach the team is to [join the PatternFly Slack workspace](https://join.slack.com/t/patternfly/shared_invite/zt-3dcejyvj6-MU93z8IVihJXxbs2ggrMEw). If you're a Red Hatter, you can also reach out on the [#list-patternfly](https://redhat.enterprise.slack.com/archives/C04JMHKSD9C) channel within the Red Hat Internal workspace. + +There are a few PatternFly Slack channels to reach out to us on: +- For general questions and help: [#general](https://patternfly.slack.com/archives/C293LQ36J) +- For questions about design: [#patternfly-design](https://patternfly.slack.com/archives/CGR204RM2) +- For HTML/CSS library questions: [#patternfly-core](https://patternfly.slack.com/archives/C9Q224EFL) +- For React library questions: [#patternfly-react](https://patternfly.slack.com/archives/C4FM977N0) \ No newline at end of file diff --git a/packages/documentation-site/patternfly-docs/content/get-help/faqs.md b/packages/documentation-site/patternfly-docs/content/get-help/faqs.md new file mode 100644 index 0000000000..c977bfb64e --- /dev/null +++ b/packages/documentation-site/patternfly-docs/content/get-help/faqs.md @@ -0,0 +1,85 @@ +--- +id: FAQs +section: get-help +source: General +sortValue: 1 +--- + +This guide provides answers to some of the questions new Flyers may have, as well as common questions the PatternFly team receives from the community. If there's a question that you believe should be addressed in these FAQs, [reach out to the PatternFly team.](/get-help/contact-us) + +## General FAQs + +### About PatternFly + +For more information about PatternFly, [check out our "About" page.](/about-us) + +#### What is PatternFly and who can use it? + +PatternFly is an open source design system for enterprise software. PatternFly is maintained by Red Hat and is used extensively across Red Hat products, but anyone can use or contribute to PatternFly. + +#### Who works on PatternFly? + +The PatternFly team is part of Red Hat's User Experience Design team and is composed of more than 20 designers, developers, and writers. + +#### How often is PatternFly updated? + +We publish a major release when we need to release breakings changes that will require significant consumer updates that will alter the way your product's code interacts with PatternFly. These are our single version numbers, like PatternFly 4, 5, or 6. + +We publish a minor release each quarter to introduce non-breaking changes, including enhancements, bug fixes, and new features. These increase the sub-version of a major release, like PatternFly 6.1, 6.2, or 6.3. + +We occasionally share patch releases between our quarterly minor releases for timely bug fixes that can't wait until the end of the quarter. These increase the sub-version of a minor release, like PatternFly 6.1.1, 6.1.2, or 6.1.3. + +#### What is the latest version of PatternFly? + +We are currently on version 6 of PatternFly—also known as "PatternFly 6". You can view the current minor and patch release version within [our release highlights.](https://www.patternfly.org/releases/release-highlights) + +### Contributing + +#### How can I contribute to PatternFly? + +You can contribute to the design and development of PatternFly, including new features as well as assisting with existing backlog issues. For more details, [refer to our contribution guidelines.](/get-involved/contribute/contribute-code) + +#### How can I report a bug that I've found? + +We encourage you to share the details of any potential bug that you'd found in your products. To alert the team, [follow our bug report guidelines.](/get-help/report-a-bug) + +#### When can I expect my bug report to be addressed? + +Our team regularly triages new bug reports based on severity and product impact. While we do our best to address critical bugs quickly, providing clear details and any relevant deadlines in your report helps us prioritize effectively. [Follow our bug report guidelines](/get-help/report-a-bug) to alert the team about an issue. + +## Designer FAQs + +### What design resources are available for PatternFly 6? + +The PatternFly 6 design kit is fully supported within our Figma libraries: +- [Components](https://www.figma.com/community/file/1357060119827689328/patternfly-6-components) +- [Patterns and extensions](https://www.figma.com/community/file/1357062621908564852/patternfly-6-patterns-extensions) + +To learn how to use our Figma libraries, [refer to our Design Kit Onboarding Resources guide.](https://www.figma.com/community/file/1357056715773763430/patternfly-6-onboarding-resources) + +### How can I ensure cross-product design consistency? + +For maximum consistency, always start with PatternFly's official component and [pattern guidelines.](/patterns/overview) If your product has specific needs that require deviation, check for established product-specific patterns on [the UXD Hub.](https://www.uxd-hub.com/) before creating a new one. This ensures alignment across the broader Red Hat ecosystem. + +## Developer FAQs + +### Which browsers are supported? + +PatternFly is supported on the 2 latest major versions of the following browsers: + +- Chrome +- Firefox +- Safari +- Edge + +### What languages are supported? + +We offer both HTML/CSS and React implementations for our components. We support React 17, 18, and 19 in PatternFly 6. + +### Where can I find documentation for previous versions + +You can navigate to the documentation for previous PatternFly versions using the version switcher in the masthead of our website. Note that we no longer maintain this documentation, with the exception of critical bug fixes in the major release prior to our current version. + +[PatternFly 3](https://pf3.patternfly.org/) +[PatternFly 4](https://v4-archive.patternfly.org/v4/) +[PatternFly 5](https://v5-archive.patternfly.org/) \ No newline at end of file diff --git a/packages/documentation-site/patternfly-docs/content/get-help/report-a-bug.md b/packages/documentation-site/patternfly-docs/content/get-help/report-a-bug.md new file mode 100644 index 0000000000..a62b1e4eae --- /dev/null +++ b/packages/documentation-site/patternfly-docs/content/get-help/report-a-bug.md @@ -0,0 +1,66 @@ +--- +id: Report a bug +section: get-help +--- + + +If you believe you've found a bug in PatternFly, we appreciate you taking the time to report it so we can resolve the issue. + + +## Before you file + + +1. **Check the documentation:** First, view the documentation for the component or feature to confirm that the behavior you're seeing is not intentional. +1. **Collect clear details:** When you file your report, please include the project or product where you noticed the bug and specify any deadlines the fix is needed for. This helps us triage and prioritize. + + +## Where to file your bug report + + +Find the appropriate repo from the following list. For each repo, first search existing issues to see if your bug has already been reported. If not, open a new issue. + + +### Design issues +Issues related to PatternFly's visual and interaction design should be contained in the [patternfly-design repo.](https://github.com/patternfly/patternfly-design/issues) + + +- [Search existing design issues](https://github.com/patternfly/patternfly-design/issues?q=is%3Aissue+is%3Aopen+) +- [Open a new design issue](https://github.com/patternfly/patternfly-design/issues/new) + + +### React issues +Bugs that are present *only* in the React implementation of a component should be contained in the [patternfly-react repo.](https://github.com/patternfly/patternfly-react/issues) + + +- [Search existing React issues](https://github.com/patternfly/patternfly-react/issues?q=is%3Aissue+is%3Aopen+) +- [Open a new React issue](https://github.com/patternfly/patternfly-react/issues/new) + + +### HTML/CSS (Core) issues +Bugs that appear in the base HTML/CSS or can be seen in *both* the React and HTML versions should be contained in the [patternfly (Core) repo.](https://github.com/patternfly/patternfly/issues) + + +- [Search existing Core issues](https://github.com/patternfly/patternfly/issues?q=is%3Aissue+is%3Aopen+) +- [Open a new Core issue](https://github.com/patternfly/patternfly/issues/new) + + +### Extension issues +For bugs found in a PatternFly extension, please file the issue in that extension's specific repository: + + +- [chatbot:](https://github.com/patternfly/chatbot) Code for [the ChatBot extension](/patternfly-ai/chatbot/about-chatbot). +- [patternfly-quickstarts:](https://github.com/patternfly/patternfly-quickstarts). Code for [the quick starts extensions](/extensions/quick-starts). +- [react-catalog-view:](https://github.com/patternfly/react-catalog-view) Code for [the catalog view extension](/extensions/catalog-view/catalog-item-header). +- [react-component-groups:](https://github.com/patternfly/react-component-groups) Code for [the component groups extension](/component-groups/about-component-groups). +- [react-data-view:](https://github.com/patternfly/react-data-view) Code for [the data view extension](/extensions/data-view/overview). +- [react-log-viewer:](https://github.com/patternfly/react-log-viewer) Code for [the log viewer extension](/extensions/log-viewer). +- [react-topology:](https://github.com/patternfly/react-topology) Code for [the Topology extension](/topology/about-topology). +- [react-user-feedback:](https://github.com/patternfly/react-user-feedback) Code for [the user feedback extension](/extensions/user-feedback). + + +### Website issues +Bugs related to the PatternFly.org website or its documentation should be contained in the [patternfly-org repo.](https://github.com/patternfly/patternfly-org/issues) + + +- [Search existing website issues](https://github.com/patternfly/patternfly-org/issues?q=is%3Aissue+is%3Aopen+) +- [Open a new website issue](https://github.com/patternfly/patternfly-org/issues/new) \ No newline at end of file diff --git a/packages/documentation-site/patternfly-docs/patternfly-docs.config.js b/packages/documentation-site/patternfly-docs/patternfly-docs.config.js index 019c74fdec..b9a4e41750 100644 --- a/packages/documentation-site/patternfly-docs/patternfly-docs.config.js +++ b/packages/documentation-site/patternfly-docs/patternfly-docs.config.js @@ -54,11 +54,13 @@ if (process.env.EXTENSIONS_ONLY === 'true') { { section: 'AI' }, { section: 'content-design' }, { section: 'developer-guides' } - ] + ], + hasDivider: true }, { title: 'Connect', items: [ + { section: 'get-help' }, { section: 'get-involved' } ] } diff --git a/packages/documentation-site/patternfly-docs/patternfly-docs.source.js b/packages/documentation-site/patternfly-docs/patternfly-docs.source.js index 1307a076c9..1d0ab51e17 100644 --- a/packages/documentation-site/patternfly-docs/patternfly-docs.source.js +++ b/packages/documentation-site/patternfly-docs/patternfly-docs.source.js @@ -22,6 +22,7 @@ module.exports = (sourceMD, sourceProps, sourceFunctionDocs) => { sourceMD(path.join(contentBase, 'AI/**/*.md'), 'AI'); + sourceMD(path.join(contentBase, 'get-help/**/*.md'), 'get-help'); sourceMD(path.join(contentBase, 'get-involved/**/*.md'), 'get-involved'); // Landing pages (now in their respective content folders)