Skip to content

Commit e26f52f

Browse files
authored
fix: Clean up broken links and design guidelines bug. (#4888)
* fix: Clean up broken links and design guidelines bug. * Remove package.json changes to fix build errors
1 parent 311c742 commit e26f52f

File tree

24 files changed

+49
-32
lines changed

24 files changed

+49
-32
lines changed

packages/documentation-framework/components/navAnnouncementBanner/navAnnouncementBanner.js

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import React from 'react';
2-
import { Alert, AlertActionCloseButton } from '@patternfly/react-core';
1+
import React, { Fragment } from 'react';
2+
import { Alert, AlertActionCloseButton, AlertActionLink } from '@patternfly/react-core';
33
import './navAnnouncementBanner.css';
44

55
export const NavAnnouncementBanner = () => {
@@ -18,8 +18,20 @@ export const NavAnnouncementBanner = () => {
1818
isInline
1919
actionClose={<AlertActionCloseButton onClose={closeBanner} />}
2020
className="ws-nav-announcement-banner"
21-
title={<>We've redesigned our website's navigation menu to make it easier to find the information you need. Learn more about the changes on <a href="https://medium.com/patternfly" target="_blank" rel="noopener noreferrer">Medium</a> and share any thoughts in our <a href="https://www.feedback.redhat.com/jfe/form/SV_9MKBjq8H7muINMy" target="_blank" rel="noopener noreferrer">user feedback survey</a>.</>}
22-
/>
21+
title="Website update"
22+
actionLinks={
23+
<Fragment>
24+
<AlertActionLink component="a" href="https://medium.com/patternfly/a-new-path-for-patternfly-org-91d14de4b93c" target="_blank">
25+
Learn more
26+
</AlertActionLink>
27+
<AlertActionLink component="a" href="https://www.feedback.redhat.com/jfe/form/SV_9MKBjq8H7muINMy" target="_blank">
28+
Share your feedback
29+
</AlertActionLink>
30+
</Fragment>
31+
}
32+
>
33+
To make it easier for you to find what you need on PatternFly.org, we've redesigned our website navigation menu.
34+
</Alert>
2335
</div>
2436
);
2537
}

packages/documentation-framework/pages/404/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ const Page404 = () => {
9797
body="Start creating your applications with components, our UI building blocks."
9898
link={{
9999
text: 'View all components',
100-
to: '/components/all-components',
100+
to: '/components/overview',
101101
}}
102102
/>
103103
<Card404

packages/documentation-framework/scripts/md/parseMD.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,11 @@ function sourceMDFile(file, source, buildMode) {
279279
if (path.basename(file).startsWith('_')) {
280280
return;
281281
}
282+
// Skip accessibility files when sourcing as design-guidelines
283+
// They should only be sourced with the 'accessibility' source
284+
if (source === 'design-guidelines' && file.includes('/accessibility/')) {
285+
return;
286+
}
282287
const { jsx, pageData, outPath } = toReactComponent(file, source, buildMode);
283288

284289
if (jsx) {

packages/documentation-site/patternfly-docs/content/AI/ai.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To support your AI practices, we provide a range of AI tools that you can integr
1313

1414
- **[Rapid prototyping](/ai/rapid-prototyping):** How to quickly test and iterate on AI features during the early stages of design.
1515
- **[AI-assisted code migration](/ai/ai-assisted-code-migration):** How to quickly test and iterate on AI features during the early stages of design.
16-
- **[Conversational Design Principles](/ai/conversational-design):** Guidance for designing effective and human-centered text-based conversational flows.
16+
- **[Conversational Design Principles](/ai/conversation-design):** Guidance for designing effective and human-centered text-based conversational flows.
1717
- **[Rapid Prototyping Guidelines](/ai/generative-uis/overview):** How to quickly test and iterate on AI features during the early stages of design.
1818

1919
Regardless of the AI resources or workflow you're using, it's important to ensure that you're aligned with the compliance rules, ethical considerations, and best practies on this page.

packages/documentation-site/patternfly-docs/content/components/charts/colors-for-charts/colors-for-charts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import './colors-for-charts.css';
1212

1313
import '../../components.css';
1414

15-
**Note:** Our charts use separate design tokens from our standard library. To view a list of all chart tokens, apply the "chart" category filter to [the design tokens table](/foundations-and-styles/design-tokens/all-patternfly-tokens).
15+
**Note:** Our charts use separate design tokens from our standard library. To view a list of all chart tokens, apply the "chart" category filter to [the design tokens table](/foundations-and-styles/design-tokens/all-design-tokens).
1616

1717
## Color palettes
1818

packages/documentation-site/patternfly-docs/content/components/date-picker/date-picker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,4 +139,4 @@ Examples:
139139

140140
<img src="./img/Error message date picker.png" alt="Date picker with error message" width="200"/>
141141

142-
For more information about writing effective error messages, see our [writing guide.](/content-design/error-messages)
142+
For more information about writing effective error messages, see our [writing guide.](/content-design/writing-guides/error-messages)

packages/documentation-site/patternfly-docs/content/components/expandable-section/expandable-section.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ An expandable section has two main elements.
1616
2. **Toggle text:** Informs the user what will be shown when the component is expanded.
1717

1818
## Usage
19-
Use an expandable section when you want to hide optional or advanced content by default. They are commonly used in forms to reveal plain text or additional form fields. They can also be used to reveal [charts](/components/charts/about-charts), [cards](/components/card), [data lists](/components/data-list), or [table views](/components/table). Expandable sections can also be used in [alerts](/components/alert) to show additional information.
19+
Use an expandable section when you want to hide optional or advanced content by default. They are commonly used in forms to reveal plain text or additional form fields. They can also be used to reveal [charts](/components/charts/overview), [cards](/components/card), [data lists](/components/data-list), or [table views](/components/table). Expandable sections can also be used in [alerts](/components/alert) to show additional information.
2020

2121
We recommend using dynamic toggle text for an expandable section, which will update the toggle text based on the state of the expandable section. For example, it may read **Show more** when the toggle is collapsed, and **Show less** when the toggle is open.
2222

packages/documentation-site/patternfly-docs/content/components/modal/modal.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ When using destructive actions, ensure that the user is informed about the conse
103103

104104
Use an error dialog to inform users of problems that interrupt normal or expected behavior. Briefly contextualize the problem and why it happened, then provide actionable steps toward a solution.
105105

106-
Learn more about writing error messages in our [error message guidelines](/content-design/error-messages).
106+
Learn more about writing error messages in our [error message guidelines](/content-design/writing-guides/error-messages).
107107

108108
Error dialogs may use an error icon for visual emphasis.
109109

packages/documentation-site/patternfly-docs/content/components/time picker/time-picker.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,14 @@ For some use cases, users may wish to customize their time display or selection
6464

6565
<img src="./img/time zone.png" alt="time zone" width="260"/>
6666

67-
Learn more about formatting and displaying time zones in our [date and time guidelines](/content-design/numerics).
67+
Learn more about formatting and displaying time zones in our [date and time guidelines](/content-design/grammar/numerics).
6868

6969
## Content considerations
7070
### Time format
7171

7272
Time formats are product-specific and often depend on user locale. To minimize confusion, choose one time format and keep it consistent. If one time picker displays HH:MM, be sure to repeat the same format throughout your interface.
7373

74-
Learn more about date and time best practices in our [date and time guidelines](/content-design/numerics).
74+
Learn more about date and time best practices in our [date and time guidelines](/content-design/grammar/numerics).
7575

7676
### Placeholder text
7777
Always use placeholder text in time fields to provide an example of the accepted time format. Placeholder text will disappear after users begin inputting their own time.

packages/documentation-site/patternfly-docs/content/components/tooltip/tooltip.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Both tooltips and [popovers](/components/popover/design-guidelines) provide more
4444
- Tooltips appear on hover, while popovers appear on click.
4545

4646
## Content considerations
47-
For content guidance, refer to [our tooltip writing guide.](/content-design/tooltips)
47+
For content guidance, refer to [our tooltip writing guide.](/content-design/writing-guides/tooltips)
4848

4949
## Accessibility
5050

0 commit comments

Comments
 (0)