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

Audit reference docs and clean-up #1643

Merged
merged 4 commits into from
May 10, 2021
Merged

Conversation

phanimarupaka
Copy link
Contributor

This PR is to audit the overview reference doc. This is displayed when user types kpt and enter. There are many global flags which are inherited from kubectl. They should be cleaned as part of separating cli from live library.

@phanimarupaka phanimarupaka self-assigned this Mar 30, 2021
@phanimarupaka phanimarupaka added documentation Improvements or additions to documentation p1 size/S 1 day triaged Issue has been triaged by adding an `area/` label labels Mar 30, 2021
site/reference/README.md Outdated Show resolved Hide resolved
site/reference/README.md Outdated Show resolved Hide resolved
@phanimarupaka
Copy link
Contributor Author

phanimarupaka commented May 9, 2021

image

image

image

image

➜  foo git:(main) ✗ kpt
Usage:
  kpt [flags]
  kpt [command]

Available Commands:
  fn          Transform and validate packages using containerized functions.
  help        Help about any command
  live        Reconcile configuration files with the live state
  pkg         Get, update, and describe packages with resources
  version     Print the version number of kpt

Not displaying flags here as they need more cleanup
➜  foo git:(main) ✗ kpt pkg
Usage:
  kpt pkg [flags]
  kpt pkg [command]

Aliases:
  pkg, package

Available Commands:
  cat         Print the resources in a file/directory
  diff        Show differences between a local package and upstream.
  get         Fetch a package from a git repo.
  init        Initialize an empty package.
  tree        Render resources using a tree structure
  update      Apply upstream package updates.

Flags:
  -h, --help   help for pkg
➜  foo git:(main) ✗ kpt fn
Usage:
  kpt fn [flags]
  kpt fn [command]

Aliases:
  fn, functions

Available Commands:
  doc         Display the documentation for a function
  eval        Locally execute one or more functions in containers
  export      Auto-generating function pipelines for different workflow orchestrators
  render      render
  sink        Specify a directory as an output sink package
  source      Specify a directory as an input source package

Flags:
  -h, --help   help for fn
➜  foo git:(main) ✗ kpt live
Usage:
  kpt live [flags]
  kpt live [command]

Available Commands:
  apply                  Apply a package to the cluster (create, update, prune).
  destroy                Remove all previously applied resources in a package from the cluster
  diff                   Display the diff between the local package and the live cluster resources.
  init                   Initialize a package with the information needed for inventory tracking.
  install-resource-group Install ResourceGroup custom resource definition as inventory object into APIServer
  migrate                Migrate inventory from ConfigMap to ResourceGroup custom resource
  preview                Preview the changes apply would make to the cluster
  status                 Display shows the status for the resources in the cluster

Not displaying flags here as they need more cleanup

@phanimarupaka phanimarupaka changed the title Audit overview doc Audit reference docs and clean-up May 10, 2021
@phanimarupaka phanimarupaka linked an issue May 10, 2021 that may be closed by this pull request
9 tasks
@phanimarupaka phanimarupaka added this to the v1.0 m2 milestone May 10, 2021
@phanimarupaka phanimarupaka merged commit 09e768f into kptdev:next May 10, 2021
frankfarzan pushed a commit to frankfarzan/kpt that referenced this pull request Jun 3, 2021
* Audit overview docs

* Suggested changes: simplify

* Update references

* fn verbatim
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation p1 size/S 1 day triaged Issue has been triaged by adding an `area/` label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

CLI usability: reference docs consistency
3 participants