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

Create vercel.json #31

Merged
merged 1 commit into from
Dec 15, 2024
Merged

Create vercel.json #31

merged 1 commit into from
Dec 15, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Dec 15, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Added a configuration file for Vercel deployment to standardize URL formatting for the documentation.

πŸ“Š Key Changes

  • πŸ“ Introduced a new vercel.json configuration file.
  • βš™οΈ Enabled the trailingSlash option, which ensures all URLs include a trailing slash.

🎯 Purpose & Impact

  • βœ… Improved URL consistency: Ensures all URLs have a uniform format with trailing slashes.
  • 🌐 Better web compatibility: Improves navigation and SEO performance for the Ultralytics documentation site hosted on Vercel.
  • πŸš€ Streamlined deployment: Simplifies future configurations and ensures smoother Vercel hosting setup.

Signed-off-by: Glenn Jocher <[email protected]>
Copy link

vercel bot commented Dec 15, 2024

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
handbook πŸ”„ Building (Inspect) Visit Preview Dec 15, 2024 6:42pm

@UltralyticsAssistant UltralyticsAssistant added devops GitHub Devops or MLops documentation Improvements or additions to documentation labels Dec 15, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting a PR to the ultralytics/handbook repository! πŸš€ Your contribution is greatly appreciated. To ensure a smooth review and integration process, please review the checklist below:

  • βœ… Define a Purpose: Clearly explain the purpose of your addition in your PR description. You've already done a great job outlining the reason for introducing vercel.json. If there are any related issues or discussions, consider linking to them for additional context.
  • βœ… Synchronize with Source: Ensure your PR is up to date with the main branch of the ultralytics/handbook repo. If not, you can resolve this by clicking the 'Update branch' button or running git pull and git merge main locally.
  • βœ… Ensure CI Checks Pass: Confirm that all relevant Continuous Integration (CI) tests are passing. If any checks fail, kindly investigate and address them promptly.
  • βœ… Update Related Documentation: If your change impacts end-user behavior, ensure that all related documentation is updated to reflect these changes.
  • βœ… Add Tests (if relevant): While adding a vercel.json file is straightforward, consider whether tests or usage notes need to be added or updated to guarantee the file’s behavior aligns with the repository's needs.
  • βœ… Sign the CLA: If this is your first contribution to Ultralytics, please confirm you have signed the Contributor License Agreement (CLA). You can do this by commenting "I have read the CLA Document and I sign the CLA" in this PR thread.
  • βœ… Minimize Changes: Keep your PR focused on the specific addition of vercel.json. As the saying goes, "Simplicity is the ultimate sophistication." 🎨

For additional details about contributing, our Contributing Guide is a great resource! Feel free to leave any comments or reach out if you need clarification.

This is an automated response to assist with the review process, but rest assured, an Ultralytics engineer will also review your PR soon. Thanks again for helping improve the ultralytics/handbook! 🌟

@glenn-jocher glenn-jocher merged commit 8d9a720 into main Dec 15, 2024
3 checks passed
@glenn-jocher glenn-jocher deleted the vercel-json branch December 15, 2024 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops GitHub Devops or MLops documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants