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

Update publish-handbook.yml #11

Merged
merged 1 commit into from
Oct 15, 2024
Merged

Update publish-handbook.yml #11

merged 1 commit into from
Oct 15, 2024

Conversation

glenn-jocher
Copy link
Member

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

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

This PR streamlines the workflow for deploying the Ultralytics handbook to GitHub Pages. πŸš€

πŸ“Š Key Changes

  • Simplified caching strategy for pip dependencies by using a single command.
  • Removed custom site build and deployment steps.
  • Replaced manual GitHub Pages deployment with mkdocs gh-deploy.

🎯 Purpose & Impact

  • Efficiency: Streamlines the deployment process, reducing complexity and potential for errors.
  • Maintainability: By leveraging mkdocs gh-deploy, ensures a standardized and cleaner deployment approach.
  • Performance: Simplifies caching, which may speed up build times by efficiently handling dependencies.

@UltralyticsAssistant UltralyticsAssistant added dependencies Dependencies and packages enhancement New feature or request labels Oct 15, 2024
@UltralyticsAssistant
Copy link
Member

πŸ‘‹ Hello @glenn-jocher, thank you for submitting your PR to the ultralytics/handbook repository! πŸš€ This is an automated response, and an Ultralytics engineer will review your changes soon. To facilitate the process, here's a quick checklist for you to consider:

  • βœ… Clarify the Purpose: Ensure you've clearly articulated the purpose of your changes in the PR description, linking to any related issues if applicable. Your commit messages should be clear and follow the project's guidelines.
  • βœ… Keep Up-to-Date: Make sure your branch is up to date with the main branch of the ultralytics/handbook repository. If needed, you can update it by clicking the 'Update branch' button or via git pull and git merge main.
  • βœ… Pass the CI Checks: Confirm all Ultralytics Continuous Integration (CI) checks are successful. If any checks fail, please address the issues to ensure they pass.
  • βœ… Documentation Updates: If your changes affect any features, ensure the relevant documentation is updated.
  • βœ… Include Tests: If applicable, provide or update tests to cover your changes and confirm that they all pass successfully.
  • βœ… Sign the CLA: Remember to sign the Contributor License Agreement if you haven't already. You can do this by writing "I have read the CLA Document and I sign the CLA" in a new comment.
  • βœ… Minimize Changes: Aim to limit your changes to what's necessary for your purpose. As Bruce Lee said, "Hack away the unessential."

For more details, please check our Contributing Guide. If you have any questions or need clarification, feel free to leave a comment here. Thank you for helping improve Ultralytics! πŸš€βœ¨

@glenn-jocher glenn-jocher merged commit 82a5ac1 into main Oct 15, 2024
1 check passed
@glenn-jocher glenn-jocher deleted the glenn-jocher-patch-1 branch October 15, 2024 17:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Dependencies and packages enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants