Skip to content

feat(templates): add templates package to versions.json #3902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wise-king-sullyman merged 4 commits into from
Mar 20, 2024
Merged

feat(templates): add templates package to versions.json #3902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2cb76c8
feat(templates): add templates package to versions.json for docs build
kmcfaul Feb 27, 2024
c326d00
add support for template inline alert
kmcfaul Feb 27, 2024
0cec4f9
add to patch version, update wording
kmcfaul Mar 14, 2024
9c0b013
update wording
kmcfaul Mar 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/documentation-framework/scripts/md/parseMD.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ function toReactComponent(mdFilePath, source, buildMode) {
section: frontmatter.section || '',
subsection: frontmatter.subsection || '',
deprecated: frontmatter.deprecated || false,
template: frontmatter.template || false,
beta: frontmatter.beta || false,
demo: frontmatter.demo || false,
newImplementationLink: frontmatter.newImplementationLink || false,
Expand Down Expand Up @@ -295,6 +296,7 @@ function sourceMDFile(file, source, buildMode) {
...(pageData.hideNavItem && { hideNavItem: pageData.hideNavItem }),
...(pageData.beta && { beta: pageData.beta }),
...(pageData.deprecated && { deprecated: pageData.deprecated }),
...(pageData.template && { template: pageData.template }),
...(pageData.demo && { demo: pageData.demo }),
...(pageData.sortValue && { sortValue: pageData.sortValue }),
...(pageData.subsectionSortValue && { subsectionSortValue: pageData.subsectionSortValue })
Expand Down
6 changes: 6 additions & 0 deletions packages/documentation-framework/templates/mdx.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ const MDXChildTemplate = ({
optIn,
beta,
deprecated,
template,
newImplementationLink,
functionDocumentation = []
} = Component.getPageData();
Expand Down Expand Up @@ -84,6 +85,11 @@ const MDXChildTemplate = ({
{' '}To learn more about the process, visit our <Link to="/get-started/about#major-release-cadence">about page</Link>.
</InlineAlert>
)}
{(template || source === 'react-template') && (
<InlineAlert title="Templates" variant="info">
{`This page showcases templates for the ${id.toLowerCase()} component. A template combines a component with logic that supports a specific use case, with a streamlined API that offers additional, limited customization.`}
</InlineAlert>
)}
</React.Fragment>
);
// Create dynamic component for @reach/router
Expand Down
9 changes: 6 additions & 3 deletions packages/documentation-framework/versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
"@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/quickstarts": "5.0.0",
"@patternfly/react-templates": "^1.0.0-alpha.0"
}
},
{
Expand All @@ -45,7 +46,8 @@
"@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/quickstarts": "5.0.0",
"@patternfly/react-templates": "^1.0.0-alpha.0"
}
},
{
Expand All @@ -69,7 +71,8 @@
"@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/quickstarts": "5.0.0",
"@patternfly/react-templates": "^1.0.0-alpha.0"
}
},{
"name": "5.1.0",
Expand Down