diff --git a/packages/documentation-site/patternfly-docs/content/contribute/contributing-to-patternfly/about-flowchart.png b/packages/documentation-site/patternfly-docs/content/contribute/contributing-to-patternfly/about-flowchart.png deleted file mode 100644 index 82b303a0a0..0000000000 Binary files a/packages/documentation-site/patternfly-docs/content/contribute/contributing-to-patternfly/about-flowchart.png and /dev/null differ diff --git a/packages/documentation-site/patternfly-docs/content/contribute/contributing-to-patternfly/contributing-to-patternfly.md b/packages/documentation-site/patternfly-docs/content/contribute/contributing-to-patternfly/contributing-to-patternfly.md deleted file mode 100644 index f282d57777..0000000000 --- a/packages/documentation-site/patternfly-docs/content/contribute/contributing-to-patternfly/contributing-to-patternfly.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -id: Contributing to PatternFly -section: get-started -subsection: contribute ---- - -The PatternFly open source community depends on contributions to help our design system grow and evolve. We encourage everyone, regardless of background, to make suggestions for enhancements, contribute new design patterns and ideas, help identify bugs in code, and more. With your help, we can stay on top of the latest and greatest implementation solutions. - -## PatternFly on GitHub -PatternFly has a few repos you can contribute to: -- [patternfly](https://github.com/patternfly/patternfly): For HTML and CSS contributions. All component contributions should start here. -- [patternfly-react](https://github.com/patternfly/patternfly-react): For React contributions. -- [patternfly-org](https://github.com/patternfly/patternfly-org): For PatternFly website content and design documentation contributions. - - -## PatternFly feature lifecycle - -PatternFly features go through a life-cycle development process that requires contributions from multiple disciplines including design, development, and content authoring. The typical feature lifecycle includes 4 phases: discovery, design, implementation, and documentation. - -![Discover, design, implement, and document are the four phases of PatternFly's feature development.](./about-flowchart.png) - -## Get help -If you run into trouble and need support, the PatternFly team is here to help. Simply reach out to us on [Slack](https://patternfly.slack.com) to get in touch. We'll always do our best to answer your questions and connect you with the right people quickly. diff --git a/packages/documentation-site/patternfly-docs/content/contribute/design/design.md b/packages/documentation-site/patternfly-docs/content/contribute/design/design.md deleted file mode 100644 index 6db887b312..0000000000 --- a/packages/documentation-site/patternfly-docs/content/contribute/design/design.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: Designer contributions -section: get-started -subsection: contribute ---- - -## Ways to contribute - -As a designer, here are some of the contributions you can make: - -### New feature or enhancement -Work with the PatternFly design team to design a new feature to be implemented in the PatternFly library. - -__Example__ -*I want to design and contribute a new design pattern that allows a user to favorite or like an item in a data list.* - -The PatternFly design team is comprised of a small number of visual and interaction designers who define the visual look and feel of the PatternFly library and provide direction to developers when implementing new features and enhancements. The team works following an agile process. The design backlog is tracked and managed via a [GitHub project board](https://github.com/orgs/patternfly/projects/7/views/30). You can look here to identify issues that are currently unassigned and waiting in the queue or [open a new issue](https://github.com/patternfly/patternfly-design/issues) to propose a design. - -### Design guideline -Design guidelines appear on the website and help designers to apply PatternFly components in their designs. They are use case and solutions driven. - -__Example__ -*I want to add guidelines for how to apply labels and tags to organize objects.* - -You may open an issue in our [patternfly-org repo](https://github.com/patternfly/patternfly-org) to propose a new design guideline page or update an existing guideline, and work with the PatternFly team and stakeholders to author and publish your new content. Visit [Contributing to patternfly org for designers](https://github.com/patternfly/patternfly-org/wiki/Contributing-to-patternfly-org-for-designers) for detailed instructions about how to author and contribute design guideline content. - -### PatternFly Sketch design kit - -**Note:** We have migrated the PatternFly design system to Figma and no longer maintain or update our Sketch design kits. The following information may be out of date as a result. For information on how to migrate to Figma, read our ["Design with PatternFly" guide.](/get-started/design) - -The [PatternFly design kit](/design#sketch-design-kit) is a [Sketch](https://www.sketch.com) library that makes it easy for designers to create high-fidelity mockups using PatternFly components. - -__Example__ -*I want to implement a new component in the PatternFly Sketch symbol library.* - -To open an issue or browse existing issues, visit the [patternfly-design-kit repo](https://github.com/patternfly/patternfly-design-kit/) on GitHub. - -### Contributing new icons -We encourage designers to work with the existing PatternFly icon set when choosing icons to use in their project. These include both custom and existing Font Awesome icons that cover most common use cases. To see what's available, vist our [Icons page](/design-foundations/icons). However, there may be occasions where you want to propose a new icon to be added to PatternFly. - -__Example__ -*I want to add a new custom icon to PatternFly to meet my project specific need.* - -To contribute a new icon, start by opening an issue in the [patternfly-design](https://github.com/patternfly/patternfly-design/issues) repo proposing a new icon and why it's needed. Then, follow the procedure outlined here for [creating custom icons](https://github.com/patternfly/patternfly-design/wiki/Creating-custom-icons) and adding them to the PatternFly icon set. - -**If you are interested in contributing to any of the projects above, feel free to reach out to us on the patternfly-design channel on [Slack](http://join.slack.com/t/patternfly/shared_invite/zt-1npmqswgk-bF2R1E2rglV8jz5DNTezMQ).** diff --git a/packages/documentation-site/patternfly-docs/content/contribute/develop/develop.md b/packages/documentation-site/patternfly-docs/content/contribute/develop/develop.md deleted file mode 100644 index dc24469c8e..0000000000 --- a/packages/documentation-site/patternfly-docs/content/contribute/develop/develop.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -id: Developer contributions -section: get-started -subsection: contribute ---- - -## Ways to contribute - -As a developer, here are some of the contributions you can make: - -### Pick up an existing HTML/CSS issue -Pick an open issue in the [patternfly repo](https://github.com/patternfly/patternfly/issues) and make a comment that you would like to contribute - -### Pick up an existing React issue -Pick an open issue in the [patternfly-react repo](https://github.com/patternfly/patternfly-react/issues) and make a comment that you would like to contribute - -### File a bug - - View the documentation for the component - - Search open issues in the [patternfly](https://github.com/patternfly/patternfly/issues) and [patternfly-react](https://github.com/patternfly/patternfly-react/issues) repos to see if a related issue exists already - - If the bug is present in only the React implementation, create a bug in the [patternfly-react repo](https://github.com/patternfly/patternfly-react/issues) - - If the bug can be seen on both the React and HTML/CSS side, it should be created on the [patternfly repo](https://github.com/patternfly/patternfly/issues) - - Mention which project the bug was noticed in and if there is a deadline that the fix is needed for - -## Detailed contribution instructions -- [Core contribution guidelines](https://github.com/patternfly/patternfly#guidelines-for-css-development) -- [React contribution guidelines](https://github.com/patternfly/patternfly-react/blob/main/CONTRIBUTING.md#contribution-process) - -## Lifecycle -![Development contribution lifecycle flowchart](./developer-flowchart.png) diff --git a/packages/documentation-site/patternfly-docs/content/contribute/develop/developer-flowchart.png b/packages/documentation-site/patternfly-docs/content/contribute/develop/developer-flowchart.png deleted file mode 100644 index 9fae0a1295..0000000000 Binary files a/packages/documentation-site/patternfly-docs/content/contribute/develop/developer-flowchart.png and /dev/null differ diff --git a/packages/documentation-site/patternfly-docs/content/get-started/contribute.md b/packages/documentation-site/patternfly-docs/content/get-started/contribute.md new file mode 100644 index 0000000000..0a909b5964 --- /dev/null +++ b/packages/documentation-site/patternfly-docs/content/get-started/contribute.md @@ -0,0 +1,71 @@ +--- +id: Contribute +title: Contribute to PatternFly +section: get-started +--- + +## Community contributions + +Thank you for your interest in contributing to PatternFly! We depend on community contributions to help our design system grow and evolve. We encourage everyone, regardless of background, to get involved. Common contributions include (but aren't limited to): +- New feature ideas. +- Bug reports. +- Documentation updates. + +This guide outlines the ways that you can contribute to PatternFly's design, code, and documentation to help us stay on top of the latest and greatest solutions. + +If you have any ideas that don't fit into the projects outlined in this guide, please [reach out to us on Slack](https://patternfly.slack.com/archives/C293LQ36J). + +## Design + +If you have skills in visual and interaction design, you can contribute to PatternFly's design by taking an existing issue or proposing a new feature, enhancement, or icon. If you are interested in any of these projects, [reach out on the patternfly-design Slack channel.](http://join.slack.com/t/patternfly/shared_invite/zt-1npmqswgk-bF2R1E2rglV8jz5DNTezMQ) + +### Existing design issues + +The PatternFly design team is composed of visual and interaction designers who define the look and feel of the PatternFly library. The team follows an agile framework, planning their work in sprints, with a backlog that is tracked and managed via [this GitHub project board.](https://github.com/orgs/patternfly/projects/7/views/30) This board contains a list issues that are currently unassigned and waiting in the queue. If you see something here that you'd like to work on, leave a comment on the issue and a member of our team will reach out with next steps. + +### 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 the 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. + +### New icons +We encourage designers to work with [the existing PatternFly icon set](/design-foundations/icons), 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 the 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. + +## Code + +The primary PatternFly libraries include HTML/CSS (commonly called "core") and React. If you're looking to contribute to PatternFly's codebase, these libraries are a good place to start. You can help out by taking existing issues, or creating issues for bugs and other changes. + +If you have any questions about these projects, you can reach out to us on our [patternfly-core](https://patternfly.slack.com/archives/C9Q224EFL) and [patternfly-react](https://patternfly.slack.com/archives/C4FM977N0) Slack channels. + +### Existing development issues + +To find work that has been approved, but not started, you can view open issues in our [patternfly](https://github.com/patternfly/patternfly/issues) (HTML/CSS) and [patternfly-react](https://github.com/patternfly/patternfly-react/issues) (React) repositories. If you find an issue that you'd like to work on, leave a comment and someone from our team will reach out to you with next steps. + +Be sure to view our detailed contribution instructions for both of these repositories: +- [Core contribution guidelines](https://github.com/patternfly/patternfly#guidelines-for-css-development) +- [React contribution guidelines](https://github.com/patternfly/patternfly-react/blob/main/CONTRIBUTING.md#contribution-process) + +### Bug reports + +If you believe that you've come across a PatternFly bug, alert our team, so that we can resolve the issue. To report a bug, follow these steps: + +1. View the documentation for the feature, to confirm that the behavior is not functioning as intended. +1. Search open issues in the [patternfly](https://github.com/patternfly/patternfly/issues) and [patternfly-react](https://github.com/patternfly/patternfly-react/issues) repositories to see if a related issue already exists. + - If the bug is present in only the React implementation of PatternFly, [create a bug issue in patternfly-react.](https://github.com/patternfly/patternfly-react/issues) + - If the bug can be seen on both the React and HTML/CSS side, [create a bug issue in patternfly](https://github.com/patternfly/patternfly/issues). +1. Be sure to mention which project the bug was noticed in and if there is a deadline that the fix is needed for. + +## Documentation + +Across our website, you can find PatternFly documentation that explains concepts, provides guidance, and outlines important resources for PatternFly users. Our documentation can always be improved, and we love to hear input from the people who use it. + +If you'd like to contribute to documentation, you can refer to our [detailed contribution instructions](https://github.com/patternfly/patternfly-org/wiki/Contributing-to-patternfly-org-for-designers) for additional guidance. + +### Existing documentation issues + +Our website documentation is contained in the [patternfly-org repository](https://github.com/patternfly/patternfly-org). If you find an issue that you'd like to work on, leave a comment and someone from our team will reach out to you with next steps. + +### Design guidelines +Our design guidelines are found across our component, layout, chart, and pattern web pages. These guides clarify usage details to help designers follow best practices to create strong UI solutions. + +If you'd like to contribute to our design guidelines, you can open an issue in [patternfly-org](https://github.com/patternfly/patternfly-org) to propose a new page or updates to an existing page. 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/patternfly-docs.source.js b/packages/documentation-site/patternfly-docs/patternfly-docs.source.js index 9e0bd4bba3..46ed18ab34 100644 --- a/packages/documentation-site/patternfly-docs/patternfly-docs.source.js +++ b/packages/documentation-site/patternfly-docs/patternfly-docs.source.js @@ -4,7 +4,6 @@ module.exports = (sourceMD, sourceProps, sourceFunctionDocs) => { // Note: you must source props before sourcing the markdown files, otherwise the props table won't be rendered. Also // source function docs (by calling sourceFunctionDocs with the package name) before sourcing markdown as well. - // Content md const contentBase = path.join(__dirname, "../patternfly-docs/content"); const reactPropsIgnore = ["**/*.test.tsx", "**/examples/*.tsx"]; sourceMD(path.join(contentBase, "extensions/**/*.md"), "extensions"); @@ -24,6 +23,7 @@ module.exports = (sourceMD, sourceProps, sourceFunctionDocs) => { "design-guidelines" ); sourceMD(path.join(contentBase, "training/**/*.md"), "training"); + sourceMD(path.join(contentBase, 'tokens/**/*.md'), 'tokens'); // Gallery pages