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

Fix incorrect info about redirects #8682

Merged
merged 3 commits into from
Jan 3, 2025

Conversation

internetisaiah
Copy link
Contributor

@internetisaiah internetisaiah commented Jan 3, 2025

Why are you making this change? (required)

There was some incorrect information about redirects throughout the contributing docs. I've also:

  • Converted redirect troubleshooting steps to an include and added it to all relevant docs.
  • Updated the headings for all YAML Meta Data sub-pages since code styling is now supported in in-page headings. I then re-ordered these sections alphabetically (which is why there are so many line changes. the vast majority of the content did not change).

Related PRs, issues, or features (optional)

  • N/A

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.

@internetisaiah internetisaiah self-assigned this Jan 3, 2025
@internetisaiah internetisaiah marked this pull request as ready for review January 3, 2025 01:52
Copy link
Collaborator

@bre-fitzgerald bre-fitzgerald left a comment

Choose a reason for hiding this comment

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

lgtm!

@bre-fitzgerald bre-fitzgerald merged commit 483cf57 into develop Jan 3, 2025
7 checks passed
@bre-fitzgerald bre-fitzgerald deleted the fix-redirect-contributing-docs branch January 3, 2025 02:00
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