diff --git a/packages/documentation-site/patternfly-docs/content/get-involved/community.md b/packages/documentation-site/patternfly-docs/content/get-involved/community.md new file mode 100644 index 0000000000..a36f1a6378 --- /dev/null +++ b/packages/documentation-site/patternfly-docs/content/get-involved/community.md @@ -0,0 +1,115 @@ +--- +id: Community +section: get-involved +--- + +import {Button, Card, CardHeader, CardTitle, CardBody, CardFooter, Divider, Grid } from '@patternfly/react-core'; +import ExternalLinkAltIcon from '@patternfly/react-icons/dist/esm/icons/external-link-alt-icon'; + +# Become a Flyer + +PatternFly's core is its global community of designers, developers, and UX professionals with a passion for open source. We call ourselves **Flyers**. + +Whether you're an active contributor or just following our releases, you're a valued member of our community. We believe that by working together, we can foster creativity and build a better design system for everyone. + +There are many ways to be a Flyer: + + + + window.open("https://join.slack.com/t/patternfly/shared_invite/zt-3dcejyvj6-MU93z8IVihJXxbs2ggrMEw"), + selectableActionAriaLabelledby:'slack-card' + }} + > + Chat with us + + + Ask questions, share feedback, and chat with the team on Slack. + + + + + + + + window.open("https://www.redhat.com/dynamic-form/instance/934b1674-bc8a-4a13-8c9d-d19abcceb263"), + selectableActionAriaLabelledby:'email-card' + }} + > + Stay up to date + + + Receive community meeting reminders and quarterly newsletters via email. + + + + + + + + window.open("https://calendar.google.com/calendar/embed?src=patternflyteam%40gmail.com&ctz=America%2FNew_York"), + selectableActionAriaLabelledby:'calendar-card' + }} + > + Join our meetings + + + Hear updates from the team in our community meetings or get help during office hours. + + + + + + + + window.open("https://medium.com/patternfly"), + selectableActionAriaLabelledby:'blog-card' + }} + > + Read our blog + + + On Medium, we share the stories behind our team's projects and practices. You can even write with us and share your own unique insights and experiences. + + + + + + + + +## Contribute to PatternFly + +We rely on community contributions to help our design system grow and evolve. Regardless of your background or experience, we encourage any Flyer to get involved by contributing bug reports, new feature ideas, documentation updates, and more. + +### Where do I start? + +A great way to get familiar with our team's processes is to [attend our biweekly office hours](https://calendar.google.com/calendar/embed?src=patternflyteam%40gmail.com&ctz=America%2FNew_York). You can listen in on discussions or sign up for a time to ask questions and chat with the team. + +When you're ready to contribute, the best place to start is to tackle a **"good first issue"** in one of the repos outlined in our contribution guides. These are tasks that our team has identified as being well-suited for new community members. + +[View our code of conduct](https://github.com/patternfly/patternfly/blob/main/CODE_OF_CONDUCT.md) and explore our contribution guides: + + + + + + + +## Explore new communities +Flyers sometimes branch out to build their own groups and projects. While the following communities are separate from PatternFly and not officially supported by our team, we love to see our ecosystem grow. + +- **[PatternFly Elements](https://patternflyelements.org):** A community-led project creating web components to use across Red Hat's sites and products. It also offers theming options for your own brand library. + +- **[PatternFly Kotlin](https://github.com/patternfly-kotlin/patternfly-kotlin):** A Kotlin implementation of PatternFly based on fritz2, built for Kotlin/JS. This project provides reactive PatternFly components that match the fritz2 API. For a quick overview, refer to [the PatternFly Kotlin showcase](https://patternfly-kotlin.github.io/patternfly-kotlin-showcase/#home). + +- **[Ansible Component Guide and Figma Library](https://www.figma.com/design/dOVzoCFCRlPXifj2WstR79/AAP-PF6-Style---Component-Guide?node-id=3-10950&t=PBFhyMs7gUxzGRH2-1):** An additional Figma library built on PatternFly components. It's a rapid prototyping tool for repeatable design patterns, tailored for Ansible but with many components applicable to other products. + +- **[PatternFly for Yew](https://github.com/patternfly-yew/patternfly-yew)**: Provides PatternFly components for Yew, a Rust framework for creating web applications with WebAssembly. For a quick demo and starter template, refer to [the PatternFly Yew Quickstart](https://github.com/patternfly-yew/patternfly-yew-quickstart). \ No newline at end of file diff --git a/packages/documentation-site/patternfly-docs/content/get-involved/contribute/contribute-code.md b/packages/documentation-site/patternfly-docs/content/get-involved/contribute/contribute-code.md new file mode 100644 index 0000000000..d81af96d79 --- /dev/null +++ b/packages/documentation-site/patternfly-docs/content/get-involved/contribute/contribute-code.md @@ -0,0 +1,75 @@ +--- +id: Contribute code +title: Contribute code +section: get-involved +subsection: Contribute +--- + +We invite developers of all skill levels to contribute code to PatternFly, either to advance our system with new features or to fix issues in our existing offerings. + +## Where do I start? + +A great way to get familiar with our team and processes is to [attend our biweekly office hours](https://calendar.google.com/calendar/embed?src=patternflyteam%40gmail.com&ctz=America%2FNew_York). You can listen in on discussions, get help with a problem, or sign up for a time to chat with the team. + +When you're ready to contribute, the best place to start is by finding a "good first issue" in one of our repos. + +## Find a good first issue + +"Good first issues" are tasks our team has identified as being well-suited for new community members. You can find these in our component repositories: + +- [patternfly (Core):](https://github.com/patternfly/patternfly/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22Good%20first%20issue%22) Our foundational HTML/CSS library. [View the Core contribution guidelines.](https://github.com/patternfly/patternfly#guidelines-for-css-development) +- [patternfly-react:](https://github.com/patternfly/patternfly-react/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22Good%20first%20issue%22) Our React library. [View the React contribution guidelines.](https://github.com/patternfly/patternfly-react/blob/main/CONTRIBUTING.md#contribution-process) + +If you find an issue you'd like to work on, leave a comment and a team member will guide you. For questions, you can reach out on the [#patternfly-core](https://patternfly.slack.com/archives/C9Q224EFL) or [#patternfly-react](https://patternfly.slack.com/archives/C4FM977N0) Slack channels. + +## Explore other code contributions + +Beyond component issues, you can also contribute to our extensions or to the PatternFly.org website itself. For any of these repositories, you can leave a comment on an issue you're interested in or ask questions in [our #general Slack channel](https://patternfly.slack.com/archives/C293LQ36J). + +- **Extensions:** These packages combine multiple base components to offer specific functionality. You can contribute to any of their repositories: + - [chatbot:](https://github.com/patternfly/chatbot) Code for [the ChatBot extension](/extensions/chatbot/overview). + - [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](/extensions/component-groups/overview). + - [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](/extensions/topology/about-topology). + - [react-user-feedback:](https://github.com/patternfly/react-user-feedback) Code for [the user feedback extension](/extensions/user-feedback). +- **PatternFly.org website:** To contribute to the functionality of our website, you can work on issues in the [patternfly-org repo](https://github.com/patternfly/patternfly-org). + +## AI-assisted development guidelines + +AI-generated code can be accepted as a contribution to this project as long as the contributor adheres to the following guidance. + +When using AI coding assistants (such as GitHub Copilot, ChatGPT, Claude, or other similar tools) to help with development work on PatternFly React, please follow these guidelines to ensure code quality, security, and transparency: + +1. **Verify and validate AI-generated code.** + + - **Treat AI-generated code as suggestions, not final code.** Review all generated code and modify as appropriate. Thoroughly review and test all code that you intend to integrate into your work. + + - **Do not automatically trust the code assistant output.** Always apply your own judgment and expertise. AI coding assistants can introduce security vulnerabilities if not used carefully, and AI models can sometimes hallucinate and provide incorrect or non-functional code. + + - **Make sure you thoroughly understand any AI-generated code.** If the generated code you intend to incorporate in your work is outside your expertise, consult with someone knowledgeable in the area prior to making it available to others. + +1. **Mark any substantial AI-generated code portions.** + + - Nontrivial and substantial AI-generated or AI-assisted content should be "marked", using one of the following approaches: + + - **In a commit message, or in a pull request/merge request description field:** Identify the code assistant that you used, perhaps elaborating on how it was used. You might also use a trailer like "Assisted-by:" or "Generated-by:". For example: + + ``` + Assisted-by: GitHub Copilot + Generated-by: ChatGPT for initial component structure + ``` + + - **In a source file comment:** Indicate the use of the code assistant. For example: + + ```javascript + // Generated by GitHub Copilot + // AI-assisted implementation with human review and modifications + ``` + +1. **Review security:** Pay special attention to security implications of AI-generated code, especially when dealing with user input, authentication, or data handling. +1. **Test your code:** Ensure that AI-generated code is thoroughly tested and meets all existing project standards for testing coverage. +1. **Review code style:** Verify that AI-generated code follows PatternFly React's coding standards and style guidelines as outlined in this document. +1. **Review documentation:** If AI assists in generating documentation or comments, review them for accuracy and completeness. \ No newline at end of file diff --git a/packages/documentation-site/patternfly-docs/content/get-involved/contribute/contribute-designs.md b/packages/documentation-site/patternfly-docs/content/get-involved/contribute/contribute-designs.md new file mode 100644 index 0000000000..5cf0d56c45 --- /dev/null +++ b/packages/documentation-site/patternfly-docs/content/get-involved/contribute/contribute-designs.md @@ -0,0 +1,28 @@ +--- +id: Contribute designs +title: Contribute designs +section: get-involved +subsection: Contribute +--- + +We invite anyone with skills in visual and interaction design to contribute to PatternFly's design by working on an existing issue or proposing a new feature, enhancement, or icon. + +## Where do I start? + +A great way to get familiar with our team's processes is to [attend our biweekly office hours](https://calendar.google.com/calendar/embed?src=patternflyteam%40gmail.com&ctz=America%2FNew_York). You can listen in on discussions or sign up for a time to ask questions and chat with the team. + +When you're ready to contribute, the best place to start is by finding an existing design issue to work on. + +## Find an existing design issue + +The PatternFly design team manages its backlog on [the design issues project board](https://github.com/orgs/patternfly/projects/7/views/58) in GitHub. The "No Sprint" view at the bottom of this board contains a list of unassigned issues that are ready for community contribution. + +If you see something that you'd like to work on, leave a comment on the issue or reach out on [our patternfly-design Slack channel](https://patternfly.slack.com/archives/CGR204RM2). + +## Propose a new feature or enhancement +If you have an idea for a new design pattern, a new component type, or an existing feature improvement, we'd love to hear it. Start by opening an issue in [our patternfly-design repository.](https://github.com/patternfly/patternfly-design/issues) From there, a member of our team will reach out and work with you to plan and design a solution. + +## Propose a new icon +We encourage designers to work with [the existing PatternFly icon set](/foundations-and-styles/iconography), which covers most common use cases. If your use case isn't covered, you can propose a new icon. + +To contribute a new icon, start by opening an issue in [our patternfly-design repository](https://github.com/patternfly/patternfly-design/issues) that describes your idea and why it's needed. A member of our team will reach out to you to discuss next steps. \ No newline at end of file diff --git a/packages/documentation-site/patternfly-docs/content/get-involved/contribute/contribute-documentation.md b/packages/documentation-site/patternfly-docs/content/get-involved/contribute/contribute-documentation.md new file mode 100644 index 0000000000..444f4fe8bf --- /dev/null +++ b/packages/documentation-site/patternfly-docs/content/get-involved/contribute/contribute-documentation.md @@ -0,0 +1,24 @@ +--- +id: Contribute documentation +title: Contribute documentation +section: get-involved +subsection: Contribute +--- + +We invite writers and subject matter experts to contribute to our website documentation. By helping us explain new concepts, provide better guidance, and outline important resources, you can help us improve the PatternFly.org experience for everyone. + +## Where do I start? + +A great way to get familiar with our team's processes is to [attend our biweekly office hours](https://calendar.google.com/calendar/embed?src=patternflyteam%40gmail.com&ctz=America%2FNew_York). You can listen in on discussions or sign up for a time to ask questions and chat with the team. + +When you're ready to contribute, the best place to start is by finding an existing documentation issue. + +## Find an existing documentation issue + +Our website documentation is contained in the [patternfly-org repository](https://github.com/patternfly/patternfly-org/issues), where you can find a list of open issues. + +If you find an issue you'd like to work on, leave a comment or reach out on [our #general Slack channel](https://patternfly.slack.com/archives/C293LQ36J) and a team member will reach out with next steps. As you work, you can refer to our [contribution guide](https://github.com/patternfly/patternfly-org/wiki/Contribution-guide) for additional guidance. + +## Propose new documentation + +If you'd like to contribute new content, such as updates to design guidelines or entirely new pages, you can propose your idea by opening an issue in the [patternfly-org repo](https://github.com/patternfly/patternfly-org). Content for design guidelines should adhere to our [writing style guide](/ux-writing/writing-patternfly-design-guidelines). From there, our team will work with you to author and publish your new content. \ No newline at end of file diff --git a/packages/documentation-site/patternfly-docs/content/get-started/develop.md b/packages/documentation-site/patternfly-docs/content/get-started/develop.md index a1b4fd0e7d..2f4c98fe38 100644 --- a/packages/documentation-site/patternfly-docs/content/get-started/develop.md +++ b/packages/documentation-site/patternfly-docs/content/get-started/develop.md @@ -177,5 +177,4 @@ Breaking changes to our React library are the result of code changes that includ - Dependencies: - Changes that alter component behavior. - Changes that alter a consumer’s build process. - - Changes to the signature of an event handler. - + - Changes to the signature of an event handler. \ 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 5f78c9f398..019c74fdec 100644 --- a/packages/documentation-site/patternfly-docs/patternfly-docs.config.js +++ b/packages/documentation-site/patternfly-docs/patternfly-docs.config.js @@ -55,6 +55,12 @@ if (process.env.EXTENSIONS_ONLY === 'true') { { section: 'content-design' }, { section: 'developer-guides' } ] + }, + { + title: 'Connect', + items: [ + { section: 'get-involved' } + ] } ], topNavItems: [], diff --git a/packages/documentation-site/patternfly-docs/patternfly-docs.source.js b/packages/documentation-site/patternfly-docs/patternfly-docs.source.js index 1e825723f7..1307a076c9 100644 --- a/packages/documentation-site/patternfly-docs/patternfly-docs.source.js +++ b/packages/documentation-site/patternfly-docs/patternfly-docs.source.js @@ -22,6 +22,8 @@ module.exports = (sourceMD, sourceProps, sourceFunctionDocs) => { sourceMD(path.join(contentBase, 'AI/**/*.md'), 'AI'); + sourceMD(path.join(contentBase, 'get-involved/**/*.md'), 'get-involved'); + // Landing pages (now in their respective content folders) sourceMD(path.join(contentBase, 'components/landing-page/**/*.md'), 'components'); sourceMD(path.join(contentBase, 'extensions/landing-page/**/*.md'), 'extensions');