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-2621: Creating Web SDK logging docs #6754

Merged
merged 11 commits into from
Apr 4, 2024
Merged

BD-2621: Creating Web SDK logging docs #6754

merged 11 commits into from
Apr 4, 2024

Conversation

internetisaiah
Copy link
Contributor

@internetisaiah internetisaiah commented Jan 18, 2024

Pull Request/Issue Resolution

Description of Change:

Creating logging documentation for the Braze Web SDK.

  • Ticket: BD-2621

  • Todo:

    • Create the general outline of the new doc.
    • For similar docs: update the article_title metadata value and in-page H1 to include the SDK type (i.e. "Swift", "Web," "Android," etc.)
    • Finalize formatting for how to best present a function and it's variables and the accepted values for each variable within the function.

Is this change associated with a Braze feature/product release?

  • Yes (Insert Feature Release Date Here)
  • No

✔️ Pull Request Checklist
  • Check that you haven't removed any images (replacing an image with an updated one of the same name is fine), as this breaks the French site
  • Check that all links work.
  • Ensure you have completed our Contributors License Agreement.
  • Tag @josh-mccrowell-braze and @bre-fitzgerald as a reviewer when your work is done and ready to be reviewed for merge. Are you an internal product manager? Reference the internal reviewing chart to tag the appropriate reviewer.
  • If the documentation involves a 1) paid SKU, 2) a third party, 3) SMS, 4) AI, or 5) privacy, ensure that Maria Maldonado on the Legal team has signed off.
  • Tag others as reviewers as necessary.
  • If you have modified any links, be sure to add redirects to assets > js > broken_redirect_list.js
⭐ Helpful Wiki Shortcuts
❗ ATTN: For PR Reviewers
  • Read our Reviewing a PR page for more on our reviewing suggestions.
  • Read our Previewing Documentation page to see how to check the deployment.
    • Preview all changes in the linked Vercel environment by clicking the preview link in the vercel-bot comment in your PR.
❗ ATTN: Internal Reviewing Chart
Work at Braze and not sure who to tag for review?
Before tagging @josh-mccrowell-braze or @bre-fitzgerald for a general review, reference the following chart to see if a specific product vertical/reviewer applies to your pull request.

Reviewer Product Vertical
@josh-mccrowell-braze Monolith Deployments
Quality Infrastructure
Platform Infrastructure
Datalake
SDKs
Currents
@bre-fitzgerald Intelligence
In-App Messages
Channels
FIX
@lydia-xie Ingestion
Core Objects
Core Messaging
Messaging Experience
Message Components
Email (Composition and Infrastructure) (tag @rachel-feinberg for Liquid use cases)
@rachel-feinberg Customer Lifecycle, Identity and Permissions
SMS
User Targeting
Reporting

@internetisaiah
Copy link
Contributor Author

@cla-bot check

@cla-bot cla-bot bot added the cla-signed label Jan 19, 2024
Copy link

cla-bot bot commented Jan 19, 2024

The cla-bot has been summoned, and re-checked this pull request!

Copy link
Contributor

@davidbielik davidbielik left a comment

Choose a reason for hiding this comment

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

LGTM!

@internetisaiah
Copy link
Contributor Author

@cla-bot check

@internetisaiah internetisaiah merged commit 8fb4018 into develop Apr 4, 2024
2 checks passed
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.

None yet

2 participants