Skip to content

Commit

Permalink
docs: DOC-1090 PCP-2590 PE-3943 4.3 Release Notes (#2342)
Browse files Browse the repository at this point in the history
* docs: DOC-1090

* save

* docs: PCP-2590

* chore: branch switch

* docs: save

* docs: more content

* chore: save

* chore: added css property

* chore: added TechnicalPreviewReleaseNoteBadge component

* docs: ready to implement

* chore: updated README

* docs: new content

* docs: more content

* chore: added packs

* docs: added reference page

* docs: fixed vertex label

* docs: fixed broken link

* docs: update

* docs: updated packs

* chore: updated release notes

* docs: added new links

* docs: updated release notes with PCG update

* chore: vale feedback

* chore: fix jest

* modify private external registry bullet

* docs: Apply suggestions from code review

Co-authored-by: Lenny Chen <[email protected]>

* docs: feedback

---------

Co-authored-by: Lenny Chen <[email protected]>
Co-authored-by: Lenny Chen <[email protected]>
  • Loading branch information
3 people authored Mar 19, 2024
1 parent e404008 commit 7641de5
Show file tree
Hide file tree
Showing 13 changed files with 272 additions and 341 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -498,6 +498,30 @@ To add a video, use the following syntax. Ensure you capitalize the letter "V":
<Video title="vsphere-pcg-creation" src="/cluster-creation-videos/vmware.mp4"></Video>
```
### Badges
The following badges are available for use:
> [!NOTE]
>
> All badges are globally available. No need to import them.
- Technical Preview Badge ![Technical Preview Badge](static/img/tech-preview-light.svg)
![Technical Preview Badge](static/img/tech-preview-dark.svg)
#### Technical Preview Badge
The technical preview badge is used to indicate that a feature is in technical preview. The badge is intended for
release notes in the context of a list. The following is an example of how to use the technical preview badge. The
component will automatically display the badge in the correct color based on the light theme (dark/light).
```markdown
- <TpBadge /> Cluster Profile variables, a new feature that allows you to define variables in a cluster profile. This
feature is in Tech Preview and is available only for Edge clusters. Profile variables allow you to define variable
types, apply validation, and more. Refer to the Cluster Profile Variables documentation to learn more about profile
variables.
```
### Simple Card Grid
This is a custom component that creates a grid of simple text cards with two columns, styled according to our color
Expand Down Expand Up @@ -742,3 +766,7 @@ make clean-versions
>
> The `docusaurus.config.js` file is updated by the [`update_docusaurus_config.js`](./docusaurus.config.js) script. DO
> NOT commit this file with the updated changes.
```
```
525 changes: 186 additions & 339 deletions docs/docs-content/release-notes.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const config = {
defaultLocale: "en",
locales: ["en"],
},
staticDirectories: ["static", "static/assets/docs/images", "static/assets"],
staticDirectories: ["static", "static/assets/docs/images", "static/assets", "static/img/"],
headTags: [
{
tagName: "script",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.customTpReleaseNoteBadge {
display: initial;
height: auto;
max-width: 100%;
margin-bottom: -5px;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
// THIS TEST IS BREAKING DUE TO JEST NOT FINDING THE @theme/ThemedImage

// import React from "react";
// import { render } from "@testing-library/react";
// import TechnicalPreviewReleaseNoteBadge from "./TechnicalPreviewReleaseNote";

// describe("TechnicalPreviewReleaseNoteBadge", () => {
// test("renders correctly", () => {
// const { container } = render(<TechnicalPreviewReleaseNoteBadge />);
// const badge = container.querySelector("img");
// expect(badge).toBeInTheDocument();
// });
// });
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import React from "react";
import ThemedImage from "@theme/ThemedImage";
import styles from "./TechnicalPreviewReleaseNote.module.scss";

// define type for TechnicalPreviewReleaseNote

export default function TechnicalPreviewReleaseNote() {
return (
<ThemedImage
alt="Technical preview feature badge"
sources={{
light: "/img/tech-preview-dark.svg",
dark: "/img/tech-preview-light.svg",
}}
className={styles.customTpReleaseNoteBadge}
/>
);
}
3 changes: 3 additions & 0 deletions src/components/Badges/TechnicalPreviewReleaseNote/index.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import TechnicalPreviewReleaseNote from "./TechnicalPreviewReleaseNote";

export default TechnicalPreviewReleaseNote;
3 changes: 3 additions & 0 deletions src/components/Badges/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import TechnicalPreviewReleaseNote from "./TechnicalPreviewReleaseNote";

export { TechnicalPreviewReleaseNote };
2 changes: 2 additions & 0 deletions src/theme/MDXComponents/MDXComponents.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import Packs from "@site/src/components/Integrations/Packs/Packs";
import AppTiers from "@site/src/components/Integrations/AppTiers/AppTiers";
import PacksTable from "@site/src/components/PacksTable/PacksTable";
import TOCInline from "@theme/TOCInline";
import { TechnicalPreviewReleaseNote as TpBadge } from "@site/src/components/Badges";
import SimpleCardGrid from "@site/src/components/SimpleCardGrid/index";

export default {
Expand All @@ -23,5 +24,6 @@ export default {
AppTiers,
PacksTable,
TOCInline,
TpBadge,
SimpleCardGrid,
};
4 changes: 4 additions & 0 deletions static/img/tech-preview-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 7641de5

Please sign in to comment.