Skip to content

Commit 77f2412

Browse files
docs(design-guidelines): Updated quickstarts guidelines. (#327)
* docs(design-guidelines): Updated quickstarts guidelines. * fix lint issues and some a11y issues * fix unit and a11y tests --------- Co-authored-by: nicolethoen <[email protected]>
1 parent 536095d commit 77f2412

File tree

12 files changed

+152
-96
lines changed

12 files changed

+152
-96
lines changed

packages/dev/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
},
1111
"dependencies": {
1212
"@patternfly/patternfly": "6.0.0-alpha.205",
13-
"@patternfly/quickstarts": "^6.0.0-alpha.4",
13+
"@patternfly/quickstarts": "^6.0.0-alpha.0",
1414
"@patternfly/react-core": "6.0.0-alpha.100",
1515
"i18next": "^19.8.3",
1616
"i18next-browser-languagedetector": "^8.0.0",

packages/dev/src/CustomCatalog.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ export const CustomCatalog: React.FC = () => {
133133
<Content component="p" className="catalog-sub">
134134
Instructional examples
135135
</Content>
136-
<Gallery hasGutter>
136+
<Gallery hasGutter className="pfext-quick-start-catalog__gallery" >
137137
{allQuickStarts
138138
.filter((quickStart: QuickStart) => quickStart.metadata.instructional)
139139
.map((quickStart: QuickStart, index: number) => {
@@ -172,7 +172,7 @@ export const CustomCatalog: React.FC = () => {
172172
<Content component="p" className="catalog-sub">
173173
Additional examples
174174
</Content>
175-
<Gallery hasGutter>
175+
<Gallery hasGutter className="pfext-quick-start-catalog__gallery" >
176176
{allQuickStarts
177177
.filter((quickStart: QuickStart) => !quickStart.metadata.instructional)
178178
.map((quickStart: QuickStart, index: number) => {

packages/module/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
"history": "^5.0.0"
5656
},
5757
"devDependencies": {
58-
"@patternfly/documentation-framework": "6.0.0-alpha.64",
58+
"@patternfly/documentation-framework": "6.0.0-alpha.79",
5959
"@patternfly/patternfly": "6.0.0-alpha.205",
6060
"@patternfly/react-icons": "6.0.0-alpha.35",
6161
"@patternfly/react-styles": "6.0.0-alpha.34",

packages/module/patternfly-docs/content/extensions/quick-starts/design-guidelines/design-guidelines.md

Lines changed: 122 additions & 50 deletions
Large diffs are not rendered by default.

packages/module/release.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ module.exports = {
2424
'@semantic-release/npm',
2525
],
2626
tagFormat: 'prerelease-v${version}',
27-
"dryRun": true,
27+
dryRun: true,
2828
};

packages/module/src/catalog/QuickStartCatalog.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ const QuickStartCatalog: React.FC<QuickStartCatalogProps> = ({ quickStarts }) =>
1515

1616
return (
1717
<div>
18-
<Gallery hasGutter>
18+
<Gallery hasGutter className="pfext-quick-start-catalog__gallery" >
1919
{quickStarts.map((quickStart, index) => {
2020
const {
2121
metadata: { name: id },

packages/module/src/catalog/QuickStartTile.tsx

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import {
2020
ButtonProps,
2121
Flex,
2222
Stack,
23-
Label
23+
Label,
2424
} from '@patternfly/react-core';
2525
import OutlinedClockIcon from '@patternfly/react-icons/dist/js/icons/outlined-clock-icon';
2626
import { StatusIcon } from '@console/shared';
@@ -65,7 +65,6 @@ const QuickStartTile: React.FC<QuickStartTileProps> = ({
6565
const { setActiveQuickStart, footer, getResource } =
6666
React.useContext<QuickStartContextValues>(QuickStartContext);
6767

68-
6968
const statusColorMap = {
7069
[QuickStartStatus.COMPLETE]: 'green',
7170
[QuickStartStatus.IN_PROGRESS]: 'purple',
@@ -153,11 +152,7 @@ const QuickStartTile: React.FC<QuickStartTileProps> = ({
153152
{quickStartIcon}
154153
</CardHeader>
155154
<CardTitle>
156-
<QuickStartTileHeader
157-
name={displayName}
158-
onSelect={onSelect}
159-
quickStartId={id}
160-
/>
155+
<QuickStartTileHeader name={displayName} onSelect={onSelect} quickStartId={id} />
161156
</CardTitle>
162157
<CardBody>
163158
<Stack hasGutter>
@@ -174,7 +169,7 @@ const QuickStartTile: React.FC<QuickStartTileProps> = ({
174169
{status !== QuickStartStatus.NOT_STARTED && (
175170
<Label
176171
variant="outline"
177-
color={statusColorMap[status] as "green" | "purple" | "grey"}
172+
color={statusColorMap[status] as 'green' | 'purple' | 'grey'}
178173
icon={<StatusIcon status={status} />}
179174
data-test="status"
180175
>

packages/module/src/catalog/QuickStartTileHeader.tsx

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,14 @@ const QuickStartTileHeader: React.FC<QuickStartTileHeaderProps> = ({
1212
name,
1313
quickStartId,
1414
onSelect,
15-
}) => {
16-
17-
return (
18-
<Flex flexWrap={{ default: 'nowrap' }}>
19-
<Title headingLevel="h3" data-test="title" id={quickStartId}>
20-
<Button variant="link" isInline onClick={onSelect}>
21-
<QuickStartMarkdownView content={name} />
22-
</Button>
23-
</Title>
24-
</Flex>
25-
);
26-
};
15+
}) => (
16+
<Flex flexWrap={{ default: 'nowrap' }}>
17+
<Title headingLevel="h3" data-test="title" id={quickStartId}>
18+
<Button variant="link" isInline onClick={onSelect}>
19+
<QuickStartMarkdownView content={name} />
20+
</Button>
21+
</Title>
22+
</Flex>
23+
);
2724

2825
export default QuickStartTileHeader;

packages/module/src/catalog/__tests__/QuickStartTile.spec.tsx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ describe('QuickStartTile', () => {
1919
);
2020
const catalogTile = wrapper.find(Card);
2121
expect(catalogTile.exists()).toBeTruthy();
22-
expect(catalogTile.prop('isSelected')).toBe(false);
2322
});
2423

2524
it('should load proper catalog tile with featured property', () => {

packages/module/src/controller/QuickStartFooter.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ const QuickStartFooter: React.FC<QuickStartFooterProps> = ({
7676
() => (
7777
<Button
7878
variant="primary"
79+
className="pfext-quick-start-footer__actionbtn"
7980
onClick={onNext}
8081
data-testid={`qs-drawer-${camelize(getPrimaryButtonText)}`}
8182
data-test={`${getPrimaryButtonText} button`}

0 commit comments

Comments
 (0)