Skip to content
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.

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

4.3 Release Notes #2342

Merged
merged 36 commits into from
Mar 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
e545877
docs: DOC-1090
karl-cardenas-coding Mar 4, 2024
18acef6
save
karl-cardenas-coding Mar 4, 2024
2f09997
docs: PCP-2590
karl-cardenas-coding Mar 4, 2024
122ed58
chore: branch switch
karl-cardenas-coding Mar 4, 2024
0a06a6a
docs: save
karl-cardenas-coding Mar 4, 2024
921df99
Merge branch 'release-4-3' of github.com:spectrocloud/librarium into …
karl-cardenas-coding Mar 5, 2024
c3b9616
docs: more content
karl-cardenas-coding Mar 5, 2024
af2c921
chore: save
karl-cardenas-coding Mar 5, 2024
9523c81
chore: added css property
karl-cardenas-coding Mar 5, 2024
fe3131a
chore: added TechnicalPreviewReleaseNoteBadge component
karl-cardenas-coding Mar 5, 2024
7a7663f
docs: ready to implement
karl-cardenas-coding Mar 5, 2024
7ea113f
chore: updated README
karl-cardenas-coding Mar 5, 2024
ae19a33
docs: new content
karl-cardenas-coding Mar 6, 2024
e122ff5
Merge branch 'release-4-3' of github.com:spectrocloud/librarium into …
karl-cardenas-coding Mar 6, 2024
dbcea04
docs: more content
karl-cardenas-coding Mar 6, 2024
722f7be
chore: added packs
karl-cardenas-coding Mar 6, 2024
378de97
Merge branch 'release-4-3' of github.com:spectrocloud/librarium into …
karl-cardenas-coding Mar 6, 2024
3ff13bc
docs: added reference page
karl-cardenas-coding Mar 6, 2024
aa52071
docs: fixed vertex label
karl-cardenas-coding Mar 6, 2024
4942446
docs: fixed broken link
karl-cardenas-coding Mar 6, 2024
4af10c6
Merge branch 'release-4-3' of github.com:spectrocloud/librarium into …
karl-cardenas-coding Mar 7, 2024
d8b79a4
docs: update
karl-cardenas-coding Mar 7, 2024
6367dc3
Merge branch 'release-4-3' of github.com:spectrocloud/librarium into …
karl-cardenas-coding Mar 8, 2024
ede7c19
docs: updated packs
karl-cardenas-coding Mar 8, 2024
0280911
chore: updated release notes
karl-cardenas-coding Mar 8, 2024
e724bec
Merge branch 'release-4-3' into rl-notes-4-3
karl-cardenas-coding Mar 11, 2024
dc41949
docs: added new links
karl-cardenas-coding Mar 11, 2024
6dc0ae1
Merge branch 'release-4-3' of github.com:spectrocloud/librarium into …
karl-cardenas-coding Mar 12, 2024
d698d8e
docs: updated release notes with PCG update
karl-cardenas-coding Mar 12, 2024
5a3c5ce
Merge branch 'release-4-3' into rl-notes-4-3
karl-cardenas-coding Mar 18, 2024
e76eb24
chore: vale feedback
karl-cardenas-coding Mar 18, 2024
2cc6c49
Merge branch 'release-4-3' into rl-notes-4-3
karl-cardenas-coding Mar 18, 2024
b3e2ac4
chore: fix jest
karl-cardenas-coding Mar 18, 2024
d588695
modify private external registry bullet
lennessyy Mar 18, 2024
dee4a53
docs: Apply suggestions from code review
karl-cardenas-coding Mar 19, 2024
f1635ae
docs: feedback
karl-cardenas-coding Mar 19, 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
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
Loading