Skip to content

Commit

Permalink
Alpha omega (#4054)
Browse files Browse the repository at this point in the history
* fix: bump to latest release candidates ahead of 5.2 release (#3862)

* fix: bump to latest release candidates ahead of 5.2 release

* bump to latest component groups prerelease

* bump react to pull in bug fix

* feat: release 5.3 (#3878)

* feat: 5.3 release

* update release highlights

* fix: Bump topology to 5.2.1 (#3881)

* fix: toplogy to 5.2.1

* add yarn.lock

* update release highlights

* Update broken link on develop.md

* chore(release): Updated component groups to 5.1.0 release (#3917)

* chore(release): releasing packages [ci skip]

 - @patternfly/ast-helpers@1.4.3
 - @patternfly/documentation-framework@5.4.3

chore(component-groups): Updated component groups to 5.1.0 release

chore(component-groups): Updated component groups to 5.1.0 release

* Updated version.json

* feat(Templates): add to org site (#3947)

* feat(Templates): add to org site

* update versions, fix Th

* hide prev version, update screenshots

* fix(docs): proper commit (#3968)

* feat(docs): update screenshots (#3969)

* Update link for deprecated alert (#3956)

* feat(docs): fix for missing props tables (#3981)

* chore(a11y): updated a11y scorecard (#3980)

* chore(a11y): updated a11y scorecard

* PR feedback - adjusted 'initial report' section with current data

* fix(misc): fix broken about links (#3987)

* add comparison table to table guidelines (#4006)

* add comparison table to table guidelines

* Update table.md

* Update table.md

* docs(tooltips): Creates separate tooltips writing guide. (#3999)

* docs(tooltips): Creates separate tooltips writing guide.

* Edits content.

* Removes unused image.

* Content edits to prep for reviews.

* Adds some aria attributes.

* Cross link from icons guide.

* fix: Incorrectly formatted link (#4024)

There was a link that was incorrectly formatted and let to a 404 page

* docs: Updates PatternFly mailing list link. (#4030)

* fix: update to official alpha omegas

* bump docs-framework version

---------

Co-authored-by: Donald Labaj <dlabaj@redhat.com>
Co-authored-by: kmcfaul <45077788+kmcfaul@users.noreply.github.com>
Co-authored-by: Jessie <jhuff@redhat.com>
Co-authored-by: Evan <evan.wilkinson@redhat.com>
Co-authored-by: Margot <51165119+mmenestr@users.noreply.github.com>
Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
Co-authored-by: Freya Gustavsson <freya@venefilyn.se>
  • Loading branch information
8 people authored Jun 3, 2024
1 parent bdf44f7 commit 37c08bc
Show file tree
Hide file tree
Showing 253 changed files with 533 additions and 369 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ You might have a dirty file tree with old submodules and folders lying around. Y

git clean -dfx

### Contribute to HTML/CSS
### Contribute to HTML/CSS

To contribute to PatternFly's HTML/CSS core repo, refer to the [core contribution guide](https://github.com/patternfly/patternfly/blob/main/patternfly-docs/site/pages/contribution.md) and the related [guidelines](https://github.com/patternfly/patternfly/blob/main/patternfly-docs/site/pages/guidelines.md).
30 changes: 15 additions & 15 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@
"license": "MIT",
"scripts": {
"analyze": "yarn workspace patternfly-org analyze",
"develop": "yarn develop:v5",
"develop:v5": "yarn workspace patternfly-org develop",
"develop:extensions": "EXTENSIONS_ONLY=true PRERELEASE=true yarn develop:v5",
"build": "yarn build:v5",
"build:analyze": "yarn workspace patternfly-org build:analyze && yarn copy:v5",
"build:v4": "yarn build:v5",
"build:v5": "yarn workspace patternfly-org build && yarn copy:v5",
"build:extensions": "EXTENSIONS_ONLY=true PRERELEASE=true yarn build:v5",
"copy:v5": "rm -rf build/patternfly-org/site && mkdir -p build/patternfly-org && cp -r packages/documentation-site/public build/patternfly-org/site",
"develop": "yarn develop:v6",
"develop:v6": "yarn workspace patternfly-org develop",
"develop:extensions": "EXTENSIONS_ONLY=true PRERELEASE=true yarn develop:v6",
"build": "yarn build:v6",
"build:analyze": "yarn workspace patternfly-org build:analyze && yarn copy:v6",
"build:v4": "yarn build:v6",
"build:v6": "yarn workspace patternfly-org build && yarn copy:v6",
"build:extensions": "EXTENSIONS_ONLY=true PRERELEASE=true yarn build:v6",
"copy:v6": "rm -rf build/patternfly-org/site && mkdir -p build/patternfly-org && cp -r packages/documentation-site/public build/patternfly-org/site",
"clean": "lerna run clean && rm -rf build",
"serve": "pf-docs-framework serve build/patternfly-org/site",
"test:v5": "yarn workspace patternfly-org test:a11y:ci",
"test:v6": "yarn workspace patternfly-org test:a11y:ci",
"screenshots": "node node_modules/puppeteer/install.js && yarn workspace patternfly-org screenshots",
"start": "yarn start:v5",
"start:v5": "yarn develop:v5",
"start": "yarn start:v6",
"start:v6": "yarn develop:v6",
"start:extensions": "yarn develop:extensions",
"uninstall": "find . -name node_modules | xargs rm -rf",
"workflows": "node .github/generate-workflows",
Expand All @@ -35,9 +35,9 @@
},
"devDependencies": {
"@patternfly/patternfly": "6.0.0-alpha.139",
"@patternfly/react-code-editor": "6.0.0-alpha.60",
"@patternfly/react-core": "6.0.0-alpha.60",
"@patternfly/react-table": "6.0.0-alpha.60",
"@patternfly/react-code-editor": "6.0.0-alpha.61",
"@patternfly/react-core": "6.0.0-alpha.61",
"@patternfly/react-table": "6.0.0-alpha.61",
"@octokit/rest": "^19.0.7",
"glob": "^8.1.0",
"lerna": "^6.4.1",
Expand Down
6 changes: 3 additions & 3 deletions packages/documentation-framework/components/footer/footer.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export const Footer = () => (
<li className="ws-org-pfsite-footer-menu-list-item">
<Link
className="ws-org-pfsite-footer-menu-link"
to={"/get-started/about"}
to={"/get-started/about-patternfly"}
aria-label="Get started with PatternFly 4"
>
Get started
Expand Down Expand Up @@ -139,9 +139,9 @@ export const Footer = () => (
<li className="ws-org-pfsite-footer-menu-list-item">
<Link
className="ws-org-pfsite-footer-menu-link"
to="//redhat.com/mailman/listinfo/patternfly"
to="https://www.redhat.com/dynamic-form/instance/934b1674-bc8a-4a13-8c9d-d19abcceb263"
target="top"
aria-label="Join the PatternFly 4 mailing list"
aria-label="Join the PatternFly mailing list"
>
Mailing list
</Link>
Expand Down
6 changes: 3 additions & 3 deletions packages/documentation-framework/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -74,9 +74,9 @@
},
"peerDependencies": {
"@patternfly/patternfly": "6.0.0-alpha.139",
"@patternfly/react-code-editor": "6.0.0-alpha.60",
"@patternfly/react-core": "6.0.0-alpha.60",
"@patternfly/react-table": "6.0.0-alpha.60",
"@patternfly/react-code-editor": "6.0.0-alpha.61",
"@patternfly/react-core": "6.0.0-alpha.61",
"@patternfly/react-table": "6.0.0-alpha.61",
"react": "^17.0.0 || ^18.0.0",
"react-dom": "^17.0.0 || ^18.0.0"
}
Expand Down
2 changes: 1 addition & 1 deletion packages/documentation-framework/pages/404/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ const Page404 = () => {
body="Learn about designing and developing with PatternFly."
link={{
text: 'View getting started resources',
to: '/get-started/about'
to: '/get-started/about-patternfly'
}}
/>
<Card404
Expand Down
4 changes: 2 additions & 2 deletions packages/documentation-framework/templates/mdx.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ const MDXChildTemplate = ({
)}
{beta && (
<InlineAlert title="Beta feature">
This beta component is currently under review and is still open for further evolution. It is available for use in product. Beta components are considered for promotion on a quarterly basis. Please join in and give us your feedback or submit any questions on the <a href="https://forum.patternfly.org/">PatternFly forum</a> or via <a href="//slack.patternfly.org/" target="_blank" rel="noopener noreferrer">Slack</a>. To learn more about the process, visit our <Link to="/get-started/about#beta-components">about page</Link> or our <a href="https://github.com/patternfly/patternfly-org/tree/main/beta-component-promotion">Beta components</a> page on GitHub.
This beta component is currently under review and is still open for further evolution. It is available for use in product. Beta components are considered for promotion on a quarterly basis. Please join in and give us your feedback or submit any questions on the <a href="https://forum.patternfly.org/">PatternFly forum</a> or via <a href="//slack.patternfly.org/" target="_blank" rel="noopener noreferrer">Slack</a>. To learn more about the process, visit our <Link to="/get-started/about-patternfly#beta-components">about page</Link> or our <a href="https://github.com/patternfly/patternfly-org/tree/main/beta-component-promotion">Beta components</a> page on GitHub.
</InlineAlert>
)}
{(deprecated || source === 'react-deprecated' || source === 'html-deprecated') && (
Expand All @@ -82,7 +82,7 @@ const MDXChildTemplate = ({
You can find the <Link to={newImplementationLink}>updated implementation here</Link>.
</React.Fragment>
)}
{' '}To learn more about the process, visit our <Link to="/get-started/about#major-release-cadence">about page</Link>.
{' '}To learn more about the process, visit our <Link to="/get-started/about-patternfly#patternfly-release-cadence">about page</Link>.
</InlineAlert>
)}
{(template || source === 'react-template') && (
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
const path = require('path');
const path = require("path");

module.exports = (sourceMD, sourceProps) => {
/** Parse source content for props so that we can display them. You must source props before sourcing the markdown
files, otherwise the props table won't be rendered.
*/
const propsIgnore = ['**/*.test.tsx', '**/examples/*.tsx'];
const extensionPath = path.join(__dirname, '../src');
sourceProps(path.join(extensionPath, '/**/*.tsx'), propsIgnore);
const propsIgnore = ["/**/*.test.tsx", "/**/examples/*.tsx"];
const extensionPath = path.join(__dirname, "../src");
sourceProps(path.join(extensionPath, "/**/*.tsx"), propsIgnore);

// Parse md files
const contentBase = path.join(__dirname, './content');
sourceMD(path.join(contentBase, 'extensions/**/*.md'), 'extensions');
// Parse md files
const contentBase = path.join(__dirname, "./content");
sourceMD(path.join(contentBase, "extensions/**/*.md"), "extensions");

/**
If you want to parse content from node_modules instead of providing a relative/absolute path,
Expand All @@ -23,4 +23,4 @@ module.exports = (sourceMD, sourceProps) => {
sourceMD(path.join(extensionPath, '../patternfly-docs/**\/demos/*.md'), 'react-demos');
sourceMD(path.join(extensionPath, '../patternfly-docs/**\/design-guidelines/*.md'), 'design-guidelines');
*/
}
};
71 changes: 10 additions & 61 deletions packages/documentation-framework/versions.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,71 +7,21 @@
"versions": {
"@patternfly/patternfly": "6.0.0-alpha.139",
"@patternfly/react-catalog-view-extension": "5.0.0",
"@patternfly/react-charts": "8.0.0-alpha.19",
"@patternfly/react-code-editor": "6.0.0-alpha.60",
"@patternfly/react-core": "6.0.0-alpha.60",
"@patternfly/react-drag-drop": "6.0.0-alpha.31",
"@patternfly/react-icons": "6.0.0-alpha.19",
"@patternfly/react-charts": "8.0.0-alpha.23",
"@patternfly/react-code-editor": "6.0.0-alpha.61",
"@patternfly/react-core": "6.0.0-alpha.61",
"@patternfly/react-drag-drop": "6.0.0-alpha.43",
"@patternfly/react-icons": "6.0.0-alpha.23",
"@patternfly/react-log-viewer": "5.0.0",
"@patternfly/react-styles": "6.0.0-alpha.19",
"@patternfly/react-table": "6.0.0-alpha.60",
"@patternfly/react-tokens": "6.0.0-alpha.19",
"@patternfly/react-styles": "6.0.0-alpha.23",
"@patternfly/react-table": "6.0.0-alpha.61",
"@patternfly/react-tokens": "6.0.0-alpha.23",
"@patternfly/react-topology": "5.1.0",
"@patternfly/quickstarts": "5.1.0",
"@patternfly/react-virtualized-extension": "5.1.0",
"@patternfly/react-templates": "^1.0.0-alpha.0"
"@patternfly/react-templates": "^6.0.0-alpha.11"
}
},{
"name": "5.2.2",
"date": "2024-03-12",
"hidden": true,
"versions": {
"@patternfly/patternfly": "5.2.1",
"@patternfly/react-charts": "7.2.2",
"@patternfly/react-code-editor": "5.2.2",
"@patternfly/react-core": "5.2.2",
"@patternfly/react-icons": "5.2.1",
"@patternfly/react-styles": "5.2.1",
"@patternfly/react-table": "5.2.2",
"@patternfly/react-drag-drop": "5.2.2",
"@patternfly/react-tokens": "5.2.1",
"@patternfly/react-catalog-view-extension": "5.0.0",
"@patternfly/react-component-groups": "5.1.0",
"@patternfly/react-console": "5.0.0",
"@patternfly/react-log-viewer": "5.2.0",
"@patternfly/react-topology": "5.2.1",
"@patternfly/react-user-feedback": "5.0.0",
"@patternfly/react-virtualized-extension": "5.0.0",
"@patternfly/quickstarts": "5.0.0",
"@patternfly/react-templates": "^1.0.0-alpha.0"
}
},
{
"name": "5.2.1",
"date": "2024-03-01",
"hidden": true,
"versions": {
"@patternfly/patternfly": "5.2.1",
"@patternfly/react-charts": "7.2.2",
"@patternfly/react-code-editor": "5.2.1",
"@patternfly/react-core": "5.2.1",
"@patternfly/react-icons": "5.2.1",
"@patternfly/react-styles": "5.2.1",
"@patternfly/react-table": "5.2.1",
"@patternfly/react-drag-drop": "5.2.1",
"@patternfly/react-tokens": "5.2.1",
"@patternfly/react-catalog-view-extension": "5.0.0",
"@patternfly/react-component-groups": "5.1.0",
"@patternfly/react-console": "5.0.0",
"@patternfly/react-log-viewer": "5.2.0",
"@patternfly/react-topology": "5.2.1",
"@patternfly/react-user-feedback": "5.0.0",
"@patternfly/react-virtualized-extension": "5.0.0",
"@patternfly/quickstarts": "5.0.0",
"@patternfly/react-templates": "^1.0.0-alpha.0"
}
},
{
"name": "5.2.0",
"date": "2024-01-17",
"hidden": true,
Expand All @@ -92,8 +42,7 @@
"@patternfly/react-topology": "5.2.1",
"@patternfly/react-user-feedback": "5.0.0",
"@patternfly/react-virtualized-extension": "5.0.0",
"@patternfly/quickstarts": "5.0.0",
"@patternfly/react-templates": "^1.0.0-alpha.0"
"@patternfly/quickstarts": "5.0.0"
}
},{
"name": "5.1.0",
Expand Down
4 changes: 2 additions & 2 deletions packages/documentation-site/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
"screenshots": "pf-docs-framework screenshots"
},
"dependencies": {
"@patternfly/documentation-framework": "6.0.0-alpha.36",
"@patternfly/documentation-framework": "6.0.0-alpha.38",
"@patternfly/quickstarts": "^5.1.0",
"@patternfly/react-catalog-view-extension": "5.0.0",
"@patternfly/react-console": "5.0.0",
"@patternfly/react-docs": "7.0.0-alpha.64",
"@patternfly/react-docs": "7.0.0-alpha.65",
"@patternfly/react-log-viewer": "5.1.0",
"@patternfly/react-topology": "5.2.1",
"@patternfly/react-user-feedback": "5.0.0",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ Every table can be extended with these functionalities:
* [Expandable table](#expandable-table)
* [Compound expandable table](#compound-expandable-table)
* [Actionable table](#actionable-table)
* [Comparison table](#comparison-table)
* [Row striping](#row-striping)
* [Sortable table](#sorting-by-columns)
* [Table with favoriting](#table-with-favoriting)
Expand Down Expand Up @@ -118,6 +119,32 @@ The actionable table provides checkboxes or radio buttons that enable users to s
#### When not to use
* Users can not take any actions on table items/rows.

### Comparison table

For tables used to compare different items against different parameters, you may use a customized version of a table.


<img src="./img/comparison-table.png" alt="example of comparison table" width="800"/>


The comparison table differs from a standard table in the follow ways:
* The items being compared should be shown as columns.
* The parameters should be a sticky column on the far left of the table, with each parameter having its own row.
* The table should contain both horizontal and vertical lines to separate items, aiding content scanning.
* The table should have a nested header for the items being compared to help visualize the data.
* (optional) The table can be striped to help scan and compare between the different parameters.
* (optional) If you choose to add actions, they should be at the individual cell level and not at the row level.

#### Actions in a comparison table

Actions in a comparison table could include:
* Adding or removing an item for comparison
* Adding or removing a parameter row for comparison
* Exporting comparison table

Although you could include the ability to remove certain parameters from inside the table, with an X button at the cell level, it is recommended that the greater management of a table be triggered from an action inside the table toolbar. For example, you could have an “Add to comparison” button in the toolbar that could open a modal in which a user could select the parameters they want to see and/or the items they want to compare.


### Row striping
Row striping can help improve legibility of a table when presenting large amounts of data. With row striping enabled, table rows will alternate between ```--pf-v6-global--BackgroundColor--100``` and ```--pf-v6-global--BackgroundColor--150``` to visually separate dense data sets.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,7 @@ Both tooltips and [popovers](/components/popover/design-guidelines) provide more
- Tooltips appear on hover, while popovers appear on click.

## Content considerations
- Keep your tooltips clear and concise. Use the fewest number of words without sacrificing meaning.
- If the tooltip is a full sentence, include a period at the end. If the tooltip is a fragment, do not include a period at the end.
- Use tooltips for additional information. Don’t use tooltips for information critical to a user completing a task, such as password character requirements.
- Tooltips should provide new and valuable information. Never use a tooltip to repeat information already available in the UI.
- Don’t use tooltips with question-circle icons to present contextual information in forms and other areas. Instead, use a [popover](/components/popover/design-guidelines).
For content guidance, refer to [our tooltip writing guide.](/ux-writing/tooltips)

## Accessibility

Expand All @@ -49,4 +45,3 @@ For information regarding accessibility, visit the [tooltip accessibility](/comp




Loading

0 comments on commit 37c08bc

Please sign in to comment.