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

BD-3318-5 Apply Diataxis standards to Liquid documentation #8219

Merged
merged 4 commits into from
Oct 15, 2024

Conversation

rachel-feinberg
Copy link
Contributor

@rachel-feinberg rachel-feinberg commented Oct 4, 2024

Why are you making this change? (required)

Apply Diataxis standards and brand voice to three Liquid articles/pages.

Related PRs, issues, or features (optional)

  • N/A

Feature release date (optional)

BD-3318

Contributor checklist

  • I confirm that my PR meets the following:
    • I signed the Contribution License Agreement (CLA).
    • My style and voice follows the Braze Style Guide.
    • My content contains correct spelling and grammar.
    • All links are working correctly.
    • If I renamed or moved a file or directory, I set up URL redirects for each file.
    • If I updated or replaced an image, I did not remove the original image file from the repository. (For more information, see Updating an image).
    • If my PR is related to a paid SKU, third party, SMS, AI, or privacy, I have received written approval from Braze Legal.

Submitting for review

If your PR meets the above requirements, select Ready for review, then add a reviewer:

  • Non-Braze contributors: Add braze-inc/docs-team as the reviewer.
  • Braze employees: Have any relevant subject matter experts (like engineers or product managers) review your work first, then add the tech writer assigned to your specific vertical. If you're not sure which tech writer to add, you can add braze-inc/docs-team instead.

Thanks for contributing! We look forward to reading your work.

@rachel-feinberg rachel-feinberg added the status: in progress Work in progress. label Oct 4, 2024
@rachel-feinberg rachel-feinberg self-assigned this Oct 4, 2024
@cla-bot cla-bot bot added the cla-signed label Oct 4, 2024
Copy link

vercel bot commented Oct 11, 2024

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

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
braze-docs-ko ⬜️ Ignored (Inspect) Visit Preview Oct 15, 2024 4:49pm

@@ -185,10 +175,27 @@ Find yourself assigning the same variables in every message? Instead of writing
As long as the Content Block is at the top of your message, every time the variable is inserted into your message as an object, it will refer to your chosen custom attribute!
{% endalert %}

### Use case
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do we have any standards around naming "Use case" headers so we don't have the same header multiple times on the page? It might help with SEO.

Copy link
Contributor Author

@rachel-feinberg rachel-feinberg Oct 15, 2024

Choose a reason for hiding this comment

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

I'll update the templates, but I've been using "Use Case" for one-off use cases that are nested under specific headers, as it's implied that the use case is for that header (in this case, variable tags). For multiple use cases that are nested under the same header, I've been using "Use Case: So-and-So". I think "Use Case #" has been used in the past.

Copy link
Collaborator

@josh-mccrowell-braze josh-mccrowell-braze left a comment

Choose a reason for hiding this comment

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

Left some comments! These are good improvements, though. Approving so I'm not a blocker.

Co-authored-by: Josh McCrowell <113209750+josh-mccrowell-braze@users.noreply.github.com>
@rachel-feinberg rachel-feinberg merged commit 3945d96 into develop Oct 15, 2024
5 checks passed
@rachel-feinberg rachel-feinberg deleted the bd-3318-5 branch October 15, 2024 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants