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

bdocs: script for auto-generating redirects + general improvements #8364

Draft
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

internetisaiah
Copy link
Contributor

@internetisaiah internetisaiah commented Nov 1, 2024

Why are you making this change? (required)

This PR contains some general improvements to bdocs that I did during my time off for fun (lol i know), as well as a new script for auto-generating the redirect file. Here's the requirements doc for more info.

TODO

  • Have user confirm that they have already made a git commit with the changed files before running command. Git can only check if filenames have been changed for committed files, not merely touched/in staging.
  • Cleanup comments/general structure (if applicable).

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.

@cla-bot cla-bot bot added the cla-signed label Nov 1, 2024
Copy link

vercel bot commented Nov 1, 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 Nov 1, 2024 11:56pm

import re
import subprocess

# Paths (assuming these are sourced or set elsewhere in your environment)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Use the global vars!

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.

1 participant