diff --git a/cmd/flux/create_image_policy.go b/cmd/flux/create_image_policy.go index 55da1a5d..dc87dea6 100644 --- a/cmd/flux/create_image_policy.go +++ b/cmd/flux/create_image_policy.go @@ -35,12 +35,12 @@ import ( var createImagePolicyCmd = &cobra.Command{ Use: "policy [name]", Short: "Create or update an ImagePolicy object", - Long: withPreviewNote(`The create image policy command generates an ImagePolicy resource. + Long: `The create image policy command generates an ImagePolicy resource. An ImagePolicy object calculates a "latest image" given an image repository and a policy, e.g., semver. The image that sorts highest according to the policy is recorded in -the status of the object.`), +the status of the object.`, Example: ` # Create an ImagePolicy to select the latest stable release flux create image policy podinfo \ --image-ref=podinfo \ diff --git a/cmd/flux/create_image_repository.go b/cmd/flux/create_image_repository.go index 3a4d351d..d4ce1fe6 100644 --- a/cmd/flux/create_image_repository.go +++ b/cmd/flux/create_image_repository.go @@ -32,8 +32,8 @@ import ( var createImageRepositoryCmd = &cobra.Command{ Use: "repository [name]", Short: "Create or update an ImageRepository object", - Long: withPreviewNote(`The create image repository command generates an ImageRepository resource. -An ImageRepository object specifies an image repository to scan.`), + Long: `The create image repository command generates an ImageRepository resource. +An ImageRepository object specifies an image repository to scan.`, Example: ` # Create an ImageRepository object to scan the alpine image repository: flux create image repository alpine-repo --image alpine --interval 20m diff --git a/cmd/flux/create_image_update.go b/cmd/flux/create_image_update.go index 8e4e7366..e1956683 100644 --- a/cmd/flux/create_image_update.go +++ b/cmd/flux/create_image_update.go @@ -29,9 +29,9 @@ import ( var createImageUpdateCmd = &cobra.Command{ Use: "update [name]", Short: "Create or update an ImageUpdateAutomation object", - Long: withPreviewNote(`The create image update command generates an ImageUpdateAutomation resource. + Long: `The create image update command generates an ImageUpdateAutomation resource. An ImageUpdateAutomation object specifies an automated update to images -mentioned in YAMLs in a git repository.`), +mentioned in YAMLs in a git repository.`, Example: ` # Configure image updates for the main repository created by flux bootstrap flux create image update flux-system \ --git-repo-ref=flux-system \ diff --git a/cmd/flux/delete_image_policy.go b/cmd/flux/delete_image_policy.go index 28115900..b99432ee 100644 --- a/cmd/flux/delete_image_policy.go +++ b/cmd/flux/delete_image_policy.go @@ -25,7 +25,7 @@ import ( var deleteImagePolicyCmd = &cobra.Command{ Use: "policy [name]", Short: "Delete an ImagePolicy object", - Long: withPreviewNote(`The delete image policy command deletes the given ImagePolicy from the cluster.`), + Long: `The delete image policy command deletes the given ImagePolicy from the cluster.`, Example: ` # Delete an image policy flux delete image policy alpine3.x`, ValidArgsFunction: resourceNamesCompletionFunc(imagev1.GroupVersion.WithKind(imagev1.ImagePolicyKind)), diff --git a/cmd/flux/delete_image_repository.go b/cmd/flux/delete_image_repository.go index 5adc3a80..de5388a6 100644 --- a/cmd/flux/delete_image_repository.go +++ b/cmd/flux/delete_image_repository.go @@ -25,7 +25,7 @@ import ( var deleteImageRepositoryCmd = &cobra.Command{ Use: "repository [name]", Short: "Delete an ImageRepository object", - Long: withPreviewNote("The delete image repository command deletes the given ImageRepository from the cluster."), + Long: "The delete image repository command deletes the given ImageRepository from the cluster.", Example: ` # Delete an image repository flux delete image repository alpine`, ValidArgsFunction: resourceNamesCompletionFunc(imagev1.GroupVersion.WithKind(imagev1.ImageRepositoryKind)), diff --git a/cmd/flux/delete_image_update.go b/cmd/flux/delete_image_update.go index 5470c303..6d94da40 100644 --- a/cmd/flux/delete_image_update.go +++ b/cmd/flux/delete_image_update.go @@ -25,7 +25,7 @@ import ( var deleteImageUpdateCmd = &cobra.Command{ Use: "update [name]", Short: "Delete an ImageUpdateAutomation object", - Long: withPreviewNote(`The delete image update command deletes the given ImageUpdateAutomation from the cluster.`), + Long: `The delete image update command deletes the given ImageUpdateAutomation from the cluster.`, Example: ` # Delete an image update automation flux delete image update latest-images`, ValidArgsFunction: resourceNamesCompletionFunc(autov1.GroupVersion.WithKind(autov1.ImageUpdateAutomationKind)), diff --git a/cmd/flux/export_image_policy.go b/cmd/flux/export_image_policy.go index 835c8a20..7bc24273 100644 --- a/cmd/flux/export_image_policy.go +++ b/cmd/flux/export_image_policy.go @@ -26,7 +26,7 @@ import ( var exportImagePolicyCmd = &cobra.Command{ Use: "policy [name]", Short: "Export ImagePolicy resources in YAML format", - Long: withPreviewNote("The export image policy command exports one or all ImagePolicy resources in YAML format."), + Long: "The export image policy command exports one or all ImagePolicy resources in YAML format.", Example: ` # Export all ImagePolicy resources flux export image policy --all > image-policies.yaml diff --git a/cmd/flux/export_image_repository.go b/cmd/flux/export_image_repository.go index 48df926d..29485789 100644 --- a/cmd/flux/export_image_repository.go +++ b/cmd/flux/export_image_repository.go @@ -26,7 +26,7 @@ import ( var exportImageRepositoryCmd = &cobra.Command{ Use: "repository [name]", Short: "Export ImageRepository resources in YAML format", - Long: withPreviewNote("The export image repository command exports one or all ImageRepository resources in YAML format."), + Long: "The export image repository command exports one or all ImageRepository resources in YAML format.", Example: ` # Export all ImageRepository resources flux export image repository --all > image-repositories.yaml diff --git a/cmd/flux/export_image_update.go b/cmd/flux/export_image_update.go index 59aae7d9..dcd93cc8 100644 --- a/cmd/flux/export_image_update.go +++ b/cmd/flux/export_image_update.go @@ -26,7 +26,7 @@ import ( var exportImageUpdateCmd = &cobra.Command{ Use: "update [name]", Short: "Export ImageUpdateAutomation resources in YAML format", - Long: withPreviewNote("The export image update command exports one or all ImageUpdateAutomation resources in YAML format."), + Long: "The export image update command exports one or all ImageUpdateAutomation resources in YAML format.", Example: ` # Export all ImageUpdateAutomation resources flux export image update --all > updates.yaml diff --git a/cmd/flux/get_image_all.go b/cmd/flux/get_image_all.go index 43bd8bd7..586e7cf1 100644 --- a/cmd/flux/get_image_all.go +++ b/cmd/flux/get_image_all.go @@ -26,7 +26,7 @@ import ( var getImageAllCmd = &cobra.Command{ Use: "all", Short: "Get all image statuses", - Long: withPreviewNote("The get image sub-commands print the statuses of all image objects."), + Long: "The get image sub-commands print the statuses of all image objects.", Example: ` # List all image objects in a namespace flux get images all --namespace=flux-system diff --git a/cmd/flux/get_image_policy.go b/cmd/flux/get_image_policy.go index cc10f307..9d261fe8 100644 --- a/cmd/flux/get_image_policy.go +++ b/cmd/flux/get_image_policy.go @@ -28,7 +28,7 @@ import ( var getImagePolicyCmd = &cobra.Command{ Use: "policy", Short: "Get ImagePolicy status", - Long: withPreviewNote("The get image policy command prints the status of ImagePolicy objects."), + Long: "The get image policy command prints the status of ImagePolicy objects.", Example: ` # List all image policies and their status flux get image policy diff --git a/cmd/flux/get_image_repository.go b/cmd/flux/get_image_repository.go index e160de8d..a19f5c2c 100644 --- a/cmd/flux/get_image_repository.go +++ b/cmd/flux/get_image_repository.go @@ -32,7 +32,7 @@ import ( var getImageRepositoryCmd = &cobra.Command{ Use: "repository", Short: "Get ImageRepository status", - Long: withPreviewNote("The get image repository command prints the status of ImageRepository objects."), + Long: "The get image repository command prints the status of ImageRepository objects.", Example: ` # List all image repositories and their status flux get image repository diff --git a/cmd/flux/get_image_update.go b/cmd/flux/get_image_update.go index f653a055..041c4920 100644 --- a/cmd/flux/get_image_update.go +++ b/cmd/flux/get_image_update.go @@ -32,7 +32,7 @@ import ( var getImageUpdateCmd = &cobra.Command{ Use: "update", Short: "Get ImageUpdateAutomation status", - Long: withPreviewNote("The get image update command prints the status of ImageUpdateAutomation objects."), + Long: "The get image update command prints the status of ImageUpdateAutomation objects.", Example: ` # List all image update automation object and their status flux get image update