Skip to content
Snippets Groups Projects
Commit 2788e257 authored by Alex Clemmer's avatar Alex Clemmer
Browse files

Small docs fixes

parent 8303bf28
No related branches found
No related tags found
No related merge requests found
......@@ -107,7 +107,7 @@ With these commands, a user can 'import "kspkg://nginx1"', and
}
var pkgDescribeCmd = &cobra.Command{
Use: "describe [<registry-name/]<package-name>",
Use: "describe [<registry-name>/]<package-name>",
Short: `Describe a ksonnet package`,
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) != 1 {
......
......@@ -22,6 +22,19 @@ var registryCmd = &cobra.Command{
RunE: func(cmd *cobra.Command, args []string) error {
return fmt.Errorf("Command 'registry' requires a subcommand\n\n%s", cmd.UsageString())
},
Long: `Manage and inspect ksonnet registries.
Registries contain a set of versioned libraries that the user can install and
manage in a ksonnet project using the CLI. A typical library contains:
1. A set of "parts", pre-fabricated API objects which can be combined together
to configure a Kubernetes application for some task. For example, the Redis
library may contain a Deployment, a Service, a Secret, and a
PersistentVolumeClaim, but if the user is operating it as a cache, they may
only need the first three of these.
2. A set of "prototypes", which are pre-fabricated combinations of these
parts, made to make it easier to get started using a library. See the
documentation for 'ks prototype' for more information.`,
}
var registryListCmd = &cobra.Command{
......@@ -77,7 +90,7 @@ var registryListCmd = &cobra.Command{
var registryDescribeCmd = &cobra.Command{
Use: "describe <registry-name>",
Short: `Manage registries for current project`,
Short: `Describe a ksonnet registry`,
RunE: func(cmd *cobra.Command, args []string) error {
if len(args) != 1 {
return fmt.Errorf("Command 'registry describe' takes one argument, which is the name of the registry to describe")
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment