docs: add beginner usage examples#31
Open
thedalbee wants to merge 1 commit into
Open
Conversation
Issue HariSekhon#6 asks for README usage examples for people new to DevOps. The README already has a broad inventory, but the first concrete run commands came much later and did not separate safe inspection from cloud or Kubernetes examples. This adds a small beginner section after setup that starts with --help, shows direct clone usage, and groups local, AWS, and Kubernetes examples without changing any scripts. Constraint: Documentation-only bounty request scoped to README usage examples Rejected: Rework the full README inventory | too broad for the issue and would make review noisy Confidence: high Scope-risk: narrow Tested: confirmed all referenced script paths exist and are executable Tested: git diff --check Not-tested: project install/build scripts due repo vet critical risk
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #6
Summary
Adds a beginner-focused usage section to the README after setup:
--helpexamples before running scriptsVerification
git diff --checkSafety note
This repository contains many install, download, and system-maintenance scripts. I kept this change documentation-only and did not run project install/build scripts locally.