From 8af1eae7f514721eba424afe373e30cb74ead444 Mon Sep 17 00:00:00 2001 From: Sam Wronski Date: Mon, 1 Feb 2021 10:45:03 -0800 Subject: [PATCH] Update kpt live init documentation. (#1397) --- internal/docs/generated/livedocs/docs.go | 20 +++++-------------- site/content/en/reference/live/init/_index.md | 5 +++-- 2 files changed, 8 insertions(+), 17 deletions(-) diff --git a/internal/docs/generated/livedocs/docs.go b/internal/docs/generated/livedocs/docs.go index 68d289a4fd..cf0f3d9832 100644 --- a/internal/docs/generated/livedocs/docs.go +++ b/internal/docs/generated/livedocs/docs.go @@ -137,22 +137,12 @@ var FetchK8sSchemaExamples = ` var InitShort = `Initialize a package with a object to track previously applied resources` var InitLong = ` - kpt live init DIRECTORY [flags] +The init command initializes a package with a template resource which will +be used to track previously applied resources so that they can be pruned +when they are deleted. -Args: - - DIR: - Path to a package directory. The directory must contain exactly - one ConfigMap with the grouping object annotation. - -Flags: - - --inventory-id: - Identifier for group of applied resources. Must be composed of valid label characters. - --namespace: - namespace for the inventory object. If not provided, kpt will check if all the resources - in the package belong in the same namespace. If they are, that namespace will be used. If - they are not, the namespace in the user's context will be chosen. +The template resource is required by other live commands +such as apply, preview and destroy. ` var InitExamples = ` # initialize a package diff --git a/site/content/en/reference/live/init/_index.md b/site/content/en/reference/live/init/_index.md index 8d75f9fbeb..0726fa8922 100644 --- a/site/content/en/reference/live/init/_index.md +++ b/site/content/en/reference/live/init/_index.md @@ -11,12 +11,14 @@ description: > {{< asciinema key="live-init" rows="10" preload="1" >}} + The init command initializes a package with a template resource which will be used to track previously applied resources so that they can be pruned when they are deleted. The template resource is required by other live commands such as apply, preview and destroy. + ### Examples @@ -32,7 +34,7 @@ kpt live init --namespace=test my-dir/ ### Synopsis - + ``` kpt live init DIRECTORY [flags] ``` @@ -55,4 +57,3 @@ DIR: in the package belong in the same namespace. If they are, that namespace will be used. If they are not, the namespace in the user's context will be chosen. ``` -