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.

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

Jump to bottom

docs: updated style guide #1418

Merged
merged 1 commit into from
Jul 13, 2023
Merged

docs: updated style guide #1418

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion styleguide/spectro-cloud-style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,8 @@ Use the info box to help users save an extra step of finding related information

Do not use emoticons in headlines or text. Emoticons are great for conveying emotions and making the text more welcoming, but at the cost of reducing the sense of the formality of the text. Our technical documentation is a place that all customers should trust. As a result, we want to convey as much professionalism as possible so that the text and its content are highly trusted.

The exception to this rule is the usage of ✅ and ❌ in markdown tables. These two symbols help the reader scan the information faster and reduce the cognitive burden of interpreting the information.

| Good ✅ | Bad ❌ |
|-------------------------------------------------------------------------|-----------------------------------------------------------------------------|
| In this tutorial, you will understand how to migrate Kubernetes clusters to Palette’s management plane. | In this tutorial you will gain a basic understanding of how to migrate Kubernetes clusters to Palette’s management plane |
Expand Down Expand Up @@ -597,4 +599,4 @@ The above table includes the following details for each parameter:

**Dependencies/Interactions**: Any dependencies or interactions with other parameters.

**Usage Example**: Practical example showcasing how the parameter is used.
**Usage Example**: Practical example showcasing how the parameter is used.