Skip to content

Conversation

@Aishwarya2001A
Copy link
Collaborator

  • Add comprehensive documentation page for chef-automate package-cleanup command
  • Add YAML command reference with detailed flag descriptions and examples
  • Document all 6 usage cases (3 non-verbose + 3 verbose scenarios)
  • Include multi-pass cleanup algorithm explanation
  • Add best practices, troubleshooting guide, and safety mechanisms
  • Document protected packages and whitelist behavior

🔩 Description: What code changed, and why?

⛓️ Related Resources

👍 Definition of Done

👟 How to Build and Test the Change

✅ Checklist

All PRs must tick these:

With occasional exceptions, all PRs from Progress employees must tick these:

  • Is the code clear? (complicated code or lots of comments--subdivide and use well-named methods, meaningful variable names, etc.)
  • Consistency checked? (user notifications, user prompts, visual patterns, code patterns, variable names)
  • Repeated code blocks eliminated? (adapt and reuse existing components, blocks, functions, etc.)
  • Spelling, grammar, typos checked? (at a minimum use make spell in any component directory)
  • Code well-formatted? (indents, line breaks, etc. improve rather than hinder readability)

All PRs from Progress employees should tick these if appropriate:

  • Tests added/updated? (all new code needs new tests)
  • Docs added/updated? (all customer-facing changes)

Please add a note next to any checkbox above if you are NOT ticking it.

📷 Screenshots, if applicable

@Aishwarya2001A Aishwarya2001A requested a review from a team as a code owner December 10, 2025 10:06
@netlify
Copy link

netlify bot commented Dec 10, 2025

Deploy Preview for chef-automate ready!

Name Link
🔨 Latest commit 7e41121
🔍 Latest deploy log https://app.netlify.com/projects/chef-automate/deploys/6939465e249c4e0008990ddf
😎 Deploy Preview https://deploy-preview-8987--chef-automate.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@Aishwarya2001A Aishwarya2001A self-assigned this Dec 10, 2025
@github-actions github-actions bot added the documentation Anything related to the Automate docs. label Dec 10, 2025
- Add comprehensive documentation page for chef-automate package-cleanup command
- Add YAML command reference with detailed flag descriptions and examples
- Document all 6 usage cases (3 non-verbose + 3 verbose scenarios)
- Include multi-pass cleanup algorithm explanation
- Add best practices, troubleshooting guide, and safety mechanisms
- Document protected packages and whitelist behavior

Signed-off-by: Aishwarya2001A <aaishwar@progress.com>
@sonarqube-for-infrastructure-prod

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Anything related to the Automate docs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants