-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add the Further Guidance admonition + link to the VMware PCG tutorial (…
…#3379) (#3381) * chore: Add the Further Guidance admonition * docs: Link to the VMware PCG tutorial * chore: Fix spelling * chore: Implement peer review (cherry picked from commit 51c3f8b) Co-authored-by: Yuliia Horbenko <31223054+yuliiiah@users.noreply.github.com>
- Loading branch information
1 parent
03f6b64
commit fa2d269
Showing
8 changed files
with
60 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
import React from "react"; | ||
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"; | ||
import { faGraduationCap } from "@fortawesome/free-solid-svg-icons"; | ||
|
||
export default function IconFurtherGuidance() { | ||
return <FontAwesomeIcon icon={faGraduationCap} />; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
import React from "react"; | ||
import clsx from "clsx"; | ||
import Translate from "@docusaurus/Translate"; | ||
import AdmonitionLayout from "@theme/Admonition/Layout"; | ||
import IconFurtherGuidance from "../Icon/FurtherGuidance"; | ||
|
||
const infimaClassName = "alert admonition-further-guidance"; | ||
|
||
const defaultProps = { | ||
icon: <IconFurtherGuidance />, | ||
title: ( | ||
<Translate | ||
id="theme.admonition.review" | ||
description="The default label used for the Further Guidance admonition (:::further)" | ||
> | ||
further guidance | ||
</Translate> | ||
), | ||
defaultText: "", | ||
}; | ||
|
||
export default function AdmonitionTypeFurtherGuidance(props) { | ||
const text = props.children || defaultProps.defaultText; | ||
return ( | ||
<AdmonitionLayout {...defaultProps} className={clsx(infimaClassName, props.className)}> | ||
{text} | ||
</AdmonitionLayout> | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,11 @@ | ||
import DefaultAdmonitionTypes from "@theme-original/Admonition/Types"; | ||
import AdmonitionTypeTechPreview from "../Admonition/Type/TechPreview"; | ||
import AdmonitionTypeFurtherGuidance from "./Type/FurtherGuidance"; | ||
|
||
const AdmonitionTypes = { | ||
...DefaultAdmonitionTypes, | ||
preview: AdmonitionTypeTechPreview, | ||
further: AdmonitionTypeFurtherGuidance, | ||
}; | ||
|
||
export default AdmonitionTypes; |