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

Add documentation for auto-scaling and auto-cancel scripts #4398

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Devansh-46
Copy link

Pull Request Title

Description

This pull request addresses the following issues:

  • Issue Add detailed documentation on auto scaling and what to expect #4230: This PR adds documentation for the auto-scaling and auto-cancel scripts, outlining their functionality and usage. The documentation provides guidance on how the scripts work, warnings about potential failures, and instructions for managing AWS usage if auto-scaling fails.

Changes Included

  • Added a new documentation file auto-scaling-and-cancel-scripts.md in the docs directory.
    • Overview: Provides an overview of the auto-scaling and auto-cancel scripts.
    • Functionality: Details how the scripts automatically scale resources and handle cancellations.
    • Warnings: Includes warnings about potential issues and instructions for checking AWS usage.
    • Contact Information: Provides guidance on how to contact support if auto-scaling fails.

Reason for Change

The documentation was added to improve clarity for users of the auto-scaling and auto-cancel scripts. It ensures that users understand the functionality, potential issues, and how to manage their AWS resources effectively.

How to Test

  1. Review the auto-scaling-and-cancel-scripts.md file located in the docs directory.
  2. Ensure that the documentation is accurate and comprehensive.
  3. Confirm that all warnings and usage instructions are clear.

Additional Information

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.30%. Comparing base (96968d6) to head (4f33e52).
Report is 1110 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4398      +/-   ##
==========================================
- Coverage   72.93%   69.30%   -3.63%     
==========================================
  Files          83       20      -63     
  Lines        5368     3574    -1794     
==========================================
- Hits         3915     2477    -1438     
+ Misses       1453     1097     -356     

see 64 files with indirect coverage changes

see 64 files with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update da7e068...4f33e52. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants