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

chore: Add a custom admonition for Tech Preview content #2017

Merged
merged 3 commits into from
Jan 12, 2024
Merged

Conversation

yuliiiah
Copy link
Contributor

@yuliiiah yuliiiah commented Jan 12, 2024

Describe the Change

This PR includes a custom admonition for Tech Preview content.

:::preview
:::

Review Changes

💻 Nutanix
💻 Harbor Edge
💻 Vxlan Overlay

🎫 DOC-1017

Copy link

netlify bot commented Jan 12, 2024

Deploy Preview for docs-spectrocloud ready!

Name Link
🔨 Latest commit 7ba60f3
🔍 Latest deploy log https://app.netlify.com/sites/docs-spectrocloud/deploys/65a1b0a86b33c90008c502c5
😎 Deploy Preview https://deploy-preview-2017--docs-spectrocloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@yuliiiah yuliiiah self-assigned this Jan 12, 2024
Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yuliiiah can you make the components use a default text with the ability to override. I'd love for us to standardize on the tech preview language 😀

@lennessyy
Copy link
Contributor

Looks great! @yuliiiah Can you go into each of the Preview features and change the adminition to preview? That way we can see a real preview?

I think these are the preview features:

  • Nutanix
  • Harbor Edge
  • Edge - Network overlay

Let me know if you have trouble finding these

@yuliiiah
Copy link
Contributor Author

yuliiiah commented Jan 12, 2024

@yuliiiah can you make the components use a default text with the ability to override. I'd love for us to standardize on the tech preview language 😀

@karl-cardenas-coding, if I remember correctly, you, @lennessyy, and the team agreed on this wording (and it's in the style guide):

XXX is a Tech Preview feature and is subject to change. Do not use this feature in production workloads.

Based on this template, we want to explicitly specify what feature we're talking about, so it's not really something I can hardcode. Do you think it would be a persistent issue to copy and paste this text from the style guide?

@karl-cardenas-coding
Copy link
Contributor

Do we need to name the feature? I think if we keep the language generic we'll be fine

@yuliiiah
Copy link
Contributor Author

@karl-cardenas-coding I've hardcoded the tech preview text. Now, if someone wants to add this admonition, it will always render the same text, even if they try to enter something different

@lennessyy I've added preview links for the pages you mentioned

Copy link
Contributor

@karl-cardenas-coding karl-cardenas-coding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fantastic. Thank you so much for creating this 💯

@yuliiiah
Copy link
Contributor Author

Happy to help @karl-cardenas-coding :) Also, since we're already here, let me quickly remind you: https://www.merriam-webster.com/dictionary/vacation

@lennessyy lennessyy added auto-backport Enable backport 4.2 backport-version-4-2 Backport change to version 4.2 and removed 4.2 labels Jan 12, 2024
@yuliiiah yuliiiah merged commit b3e3f5a into master Jan 12, 2024
9 of 10 checks passed
@yuliiiah yuliiiah deleted the doc-1017 branch January 12, 2024 21:51
@vault-token-factory-spectrocloud
Copy link
Contributor

💔 All backports failed

Status Branch Result
version-4-2 Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

backport --pr 2017

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

@lennessyy
Copy link
Contributor

Hi @yuliiiah , it looks like the auto backport failed for version 4.2. Putting this on your radar in case you missed it.

@yuliiiah
Copy link
Contributor Author

Hi @yuliiiah , it looks like the auto backport failed for version 4.2. Putting this on your radar in case you missed it.

Oh wow, @lennessyy, thank you so much! I totally missed this. Will backport tomorrow once we're done with Prettier :)

@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This PR is included in version 4.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@vault-token-factory-spectrocloud
Copy link
Contributor

🎉 This PR is included in version 4.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Enable backport backport-version-4-2 Backport change to version 4.2 released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants