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

[DI-6749] Restore the autogenerated Currents events docs #8349

Merged
merged 4 commits into from
Oct 31, 2024

Conversation

isturdy
Copy link
Contributor

@isturdy isturdy commented Oct 31, 2024

Why are you making this change? (required)

This adds payload documentation for non-Storage Currents destinations, as well as fixing numerous cases where the existing docs had fallen out of sync with what we actually send.

Related PRs, issues, or features (optional)

Feature release date (optional)

  • N/A

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.

@isturdy isturdy requested review from a team as code owners October 31, 2024 17:00
@rachel-feinberg rachel-feinberg self-requested a review October 31, 2024 17:11
.tool-versions Outdated
@@ -0,0 +1 @@
ruby 3.3.0
Copy link
Collaborator

Choose a reason for hiding this comment

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

Was this update intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oops, no--just added it to get rake to work locally. Removed.

Copy link

vercel bot commented Oct 31, 2024

@isturdy is attempting to deploy a commit to the Braze team on Vercel, but is not a member of this team. To resolve this issue, you can:

  • Make your repository public. Collaboration is free for open source and public repositories.
  • Add @isturdy as a member. A Pro subscription is required to access Vercel's collaborative features.
    • If you're the owner of the team, click here and add @isturdy as a member.
    • If you're the user who initiated this build request, click here to request access.
    • If you're already a member of the Braze team, make sure that your Vercel account is connected to your GitHub account.

To read more about collaboration on Vercel, click here.

@cla-bot cla-bot bot added the cla-signed label Oct 31, 2024
…com:braze-inc/braze-docs into di-6749-restore-autogenerated-currents-docs

fix
Copy link

vercel bot commented Oct 31, 2024

@rachel-feinberg is attempting to deploy a commit to the Braze team on Vercel, but is not a member of this team. To resolve this issue, you can:

  • Make your repository public. Collaboration is free for open source and public repositories.
  • Add @rachel-feinberg as a member. A Pro subscription is required to access Vercel's collaborative features.
    • If you're the owner of the team, click here and add @rachel-feinberg as a member.
    • If you're the user who initiated this build request, click here to request access.
    • If you're already a member of the Braze team, make sure that your Vercel account is connected to your GitHub account.

To read more about collaboration on Vercel, click here.

Copy link
Contributor

@rachel-feinberg rachel-feinberg left a comment

Choose a reason for hiding this comment

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

Went through for a Docs review! LGTM

@flybonzai
Copy link
Contributor

@josh-mccrowell-braze @rachel-feinberg who do we need to merge this?

@rachel-feinberg rachel-feinberg merged commit de20669 into develop Oct 31, 2024
1 of 4 checks passed
@rachel-feinberg rachel-feinberg deleted the di-6749-restore-autogenerated-currents-docs branch October 31, 2024 20:06
@rachel-feinberg
Copy link
Contributor

@flybonzai I merged it in! 😄

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.

4 participants