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-3275] Simplify Dev Guide Nav #8302

Merged
merged 6 commits into from
Nov 7, 2024
Merged

Conversation

internetisaiah
Copy link
Contributor

@internetisaiah internetisaiah commented Oct 25, 2024

Why are you making this change? (required)

In preparation for the full dev guide detangle, this PR aims to clean up the nav bar. Note: I did my best to not change directory names and only change nav_title: keys, to minimize the amount of redirects needed. All the top-level directories will be renamed in the future though--all at once.

NOTE TO REVIEWERS!

To auto-generate a list of all the old URLs so you can easily test the redirects, enter the following commands into the terminal, then follow the prompts in the terminal window.

cd braze-docs
git checkout simplify-dev-guide-nav
git fetch origin simplify-dev-guide-nav

./bdocs redirects

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 Oct 25, 2024
Copy link

vercel bot commented Oct 25, 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 7, 2024 5:18pm

@internetisaiah
Copy link
Contributor Author

internetisaiah commented Oct 28, 2024

All that needs to be completed before merging:

  • Create redirects for files
  • Fix all the Git conflicts
  • Update references to specific headers that were changed (as needed)

@internetisaiah
Copy link
Contributor Author

@cla-bot check

@internetisaiah internetisaiah marked this pull request as ready for review November 5, 2024 18:06
@internetisaiah internetisaiah requested review from a team and Bucimis November 5, 2024 18:10
@internetisaiah
Copy link
Contributor Author

@cla-bot check

Copy link

cla-bot bot commented Nov 5, 2024

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

Copy link
Contributor

@Bucimis Bucimis left a comment

Choose a reason for hiding this comment

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

lgtm when comments addressed

_docs/_developer_guide/authentication.md Show resolved Hide resolved
_docs/_developer_guide/debugging.md Show resolved Hide resolved
Copy link
Contributor

@lydia-xie lydia-xie left a comment

Choose a reason for hiding this comment

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

looks good from my end! feel free to merge when you're ready :) great work

@internetisaiah internetisaiah merged commit 5f4673f into develop Nov 7, 2024
5 checks passed
@internetisaiah internetisaiah deleted the simplify-dev-guide-nav branch November 7, 2024 17:56
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.

3 participants