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.

Sign up for GitHub

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

docs: kickstart rationale doc #257

Merged
merged 1 commit into from
Nov 29, 2023
Merged

docs: kickstart rationale doc #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions RATIONALE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Notable rationale of deployer toolkit

## command line flags convention

The canonical representation of flags in this package is:
* single-dash for one-char flags (-v, -h)
* double-dash for multi-char flags (--foo, --long-option)
pflag allows one-char to have one or two dashes.

The tooling we configure all use `pflag`, so our canonical
representation is more restrictive of those.
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ the `deployer` project wants to help anyone which want to work with the topology
- a set of reusable golang packages which can be used by other golang projects to deploy/undeploy or in general
interact with the topology-aware stack components (e.g. operators)

please check `RATIONALE.md` for more detailed development notes about rationale for technical decisions.

## requirements

* kubernetes >= 1.21
Expand Down