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

fix(Style guide): Modified the preview callout title #17826

Merged
merged 7 commits into from
Jul 16, 2024
Merged

fix(Style guide): Modified the preview callout title #17826

merged 7 commits into from
Jul 16, 2024

Conversation

nbaenam
Copy link
Contributor

@nbaenam nbaenam commented Jun 28, 2024

Updated the callout preview in the style guide and throughout the docs site.

@nbaenam nbaenam added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels Jun 28, 2024
@nbaenam nbaenam requested a review from rhetoric101 June 28, 2024 12:50
@nbaenam nbaenam self-assigned this Jun 28, 2024
@github-actions GitHub Actions
Copy link

Hi @nbaenam 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

@netlify Netlify
Copy link

netlify bot commented Jun 28, 2024 •
edited
Loading

✅ Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit 7e147c3
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/66963da06aecc100080d0392
😎 Deploy Preview https://deploy-preview-17826--docs-website-netlify.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.

@nbaenam nbaenam removed the request for review from ally-sassman June 28, 2024 15:05
ally-sassman
ally-sassman requested changes Jun 28, 2024
View reviewed changes
Copy link
Contributor

@ally-sassman ally-sassman left a comment •
edited
Loading

Choose a reason for hiding this comment

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

@nbaenam All of the callout titles should be uppercased, so <Callout title="preview"> should be <Callout title="Preview">

ally-sassman
ally-sassman previously approved these changes Jul 1, 2024
View reviewed changes
@rhetoric101
Copy link
Contributor

@nbaenam I'm working with the legal team to clarify our callout message. Let's not publish this until we get clarity on this from them.

@rhetoric101 rhetoric101 mentioned this pull request Jul 3, 2024
Merged
rhetoric101
rhetoric101 reviewed Jul 12, 2024
View reviewed changes
Copy link
Contributor

@rhetoric101 rhetoric101 left a comment

Choose a reason for hiding this comment

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

@nbaenam I think we're supposed to add this legal language into each existing preview callout.

src/content/docs/style-guide/word-choice/usage-dictionary.mdx Outdated Show resolved Hide resolved
src/content/docs/alerts/incident-management/postmortems-applied-intelligence.mdx Show resolved Hide resolved
...ntent/docs/infrastructure/host-integrations/host-integrations-list/atlassian-integration.mdx Show resolved Hide resolved
...ocs/infrastructure/host-integrations/host-integrations-list/ibmmq-monitoring-integration.mdx Show resolved Hide resolved
.../infrastructure/host-integrations/host-integrations-list/powerdns-monitoring-integration.mdx Show resolved Hide resolved
...content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-eks-fargate.mdx Show resolved Hide resolved
src/content/docs/kubernetes-pixie/kubernetes-integration/installation/kubernetes-windows.mdx Show resolved Hide resolved
src/content/docs/nrql/using-nrql/query-infrastructure-dimensional-metrics-nrql.mdx Show resolved Hide resolved
src/content/docs/style-guide/word-choice/usage-dictionary.mdx Show resolved Hide resolved
src/install/ibm-mq/intro.mdx Show resolved Hide resolved
@nbaenam nbaenam requested a review from rhetoric101 July 15, 2024 15:45
rhetoric101
rhetoric101 reviewed Jul 15, 2024
View reviewed changes
Copy link
Contributor

@rhetoric101 rhetoric101 left a comment

Choose a reason for hiding this comment

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

@nbaenam sorry to slow this down, but I found two more items to consider. What do you think?

src/content/docs/style-guide/structure/callouts.mdx Outdated Show resolved Hide resolved
src/content/docs/style-guide/word-choice/usage-dictionary.mdx Outdated Show resolved Hide resolved
@nbaenam nbaenam requested a review from rhetoric101 July 16, 2024 09:31
rhetoric101
rhetoric101 approved these changes Jul 16, 2024
View reviewed changes
Copy link
Contributor

@rhetoric101 rhetoric101 left a comment

Choose a reason for hiding this comment

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

@nbaenam thanks for adding these changes! This looks good to me!

@nbaenam nbaenam merged commit 2b10dad into develop Jul 16, 2024
20 checks passed
@nbaenam nbaenam deleted the nb-style-guide-callout-preview branch July 16, 2024 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rhetoric101 rhetoric101 rhetoric101 approved these changes

@ally-sassman ally-sassman ally-sassman left review comments

Assignees

@nbaenam nbaenam

Labels
content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nbaenam @rhetoric101 @ally-sassman @austin-schaefer