Skip to content

Adding a voice and tone page #2812

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Adding a voice and tone page #2812

wants to merge 6 commits into from

Conversation

heatherlarsen
Copy link
Contributor

@heatherlarsen heatherlarsen commented Apr 4, 2025

📌 Summary

If merged, this PR will add a "Voice and tone" page adapted from the Marketing team's guidelines: https://hashicorp.atlassian.net/wiki/spaces/CCAS/pages/3377922084/Our+tone

👉🏻 Preview: https://hds-website-git-hl-docs-tone-voice-hashicorp.vercel.app/content/voice-tone

✔️ TODO

📷 Screenshots

Since the Sidecar is still broken (#2815), they won't display appropriately in the Vercel deployment. This is what it looks like locally at various screen sizes:
Screenshot 2025-04-17 at 10 55 22 AM

Screenshot 2025-04-17 at 10 55 39 AM

Screenshot 2025-04-17 at 10 55 57 AM

🔗 External links

Jira ticket: HDS-4291


👀 Component checklist

💬 Please consider using conventional comments when reviewing this PR.

@heatherlarsen heatherlarsen requested review from a team as code owners April 4, 2025 20:24
Copy link

vercel bot commented Apr 4, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Apr 17, 2025 0:10am
hds-website ✅ Ready (Inspect) Visit Preview Apr 17, 2025 0:10am

@hashibot-hds hashibot-hds added the docs-website Content updates to the documentation website label Apr 4, 2025
@heatherlarsen heatherlarsen marked this pull request as draft April 4, 2025 20:29
This is a bit hacky, but the blocks get really large when there is no sidecar

**Our tone** is how we speak and say things to our users. Tone sets the mood of your writing and can change depending on the type of content you’re creating.

<Doc::Layout @spacing="12px">
Copy link
Contributor

Choose a reason for hiding this comment

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

[idea] general consideration: since this is a "special" (non-standard) page, we could also consider having a special custom content layout / visual treatment for it, think of the "principles" page for example (in which case, we can implement it per your design specs); if you instead want to keep it simple, as you've implemented it it's OK but I would probably use a CSS class instead of Doc::Layout so we can have a more responsive layout at small screens (stacked content, instead of side by side)
screenshot_4851

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a great suggestion. I've given this a try and am curious to see what you think of the new approach.

Copy link
Contributor

Choose a reason for hiding this comment

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

The layout doesn't seem to be working quite right. The Do & Dont blocks stack at almost all browser window widths. They line up side by side only within a small range of widths. Maybe that's the intention though?

It seems to me like there should/could be a greater range of views in which they display side by side.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unfortunately, it's because the sidecar is still displaying in the Vercel deployment. When I test it locally, the sidecar isn't there (which is the intention, but there's a bug being looked at in #2815), so they're side by side more often. I'll drop some screenshots in the description, but feel free to test locally as well.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see, thanks for explaining

Instead of using <Doc::Layout> i've added a special class that will display do and dont elements in a single row, then adjust to stacked as the browser shrinks.
Copy link
Contributor

@KristinLBradley KristinLBradley left a comment

Choose a reason for hiding this comment

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

Approving so this can be merged.

I think the content is good but the responsive layout of the Do & Dont could still use refining. I don't think that's a blocker though & could be worked on later.

Copy link
Contributor

@jorytindall jorytindall left a comment

Choose a reason for hiding this comment

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

I agree with @KristinLBradley , the responsive layout still needs a bit of work, but I think the content is good. It's a combination of the viewport width changing, plus the sidecar being hidden that is causing things to jump around a bit. Let me know if you want to pair on it, might be a slightly different way to approach it.
CleanShot 2025-04-18 at 15 57 08

@heatherlarsen
Copy link
Contributor Author

heatherlarsen commented Apr 18, 2025

@jorytindall, thanks for taking a look! This is a byproduct of the broken sidecar. Once the sidecar is fixed, it won't jump back and forth like this. Here's what it looks like without the sidecar on local:

Voice.and.tone._.Helios.Design.System.mp4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants