From 398deec2725a128fe3f2cd674f48cb364f105daf Mon Sep 17 00:00:00 2001 From: cellarspoon Date: Mon, 20 Dec 2021 00:15:42 +0100 Subject: [PATCH] docs: improved recipe maintainer docs --- cli/catalogue/catalogue.go | 2 +- cli/recipe/recipe.go | 9 +++++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/cli/catalogue/catalogue.go b/cli/catalogue/catalogue.go index 1deee22b..ae8c8c8a 100644 --- a/cli/catalogue/catalogue.go +++ b/cli/catalogue/catalogue.go @@ -247,7 +247,7 @@ A new catalogue copy can be published to the recipes repository by passing the // CatalogueCommand defines the `abra catalogue` command and sub-commands. var CatalogueCommand = &cli.Command{ Name: "catalogue", - Usage: "Manage the recipe catalogue (for maintainers)", + Usage: "Manage the recipe catalogue", Aliases: []string{"c"}, ArgsUsage: "", Description: "This command helps recipe packagers interact with the recipe catalogue", diff --git a/cli/recipe/recipe.go b/cli/recipe/recipe.go index 328cbe4f..5933b190 100644 --- a/cli/recipe/recipe.go +++ b/cli/recipe/recipe.go @@ -7,13 +7,18 @@ import ( // RecipeCommand defines all recipe related sub-commands. var RecipeCommand = &cli.Command{ Name: "recipe", - Usage: "Manage recipes (for maintainers)", + Usage: "Manage recipes", ArgsUsage: "", Aliases: []string{"r"}, Description: ` -A recipe is a blueprint for an app. It is a bunch of configuration files which +A recipe is a blueprint for an app. It is a bunch of config files which describe how to deploy and maintain an app. Recipes are maintained by the Co-op Cloud community and you can use Abra to read them and create apps for you. + +Anyone who uses a recipe can become a maintainer. Maintainers typically make +sure the recipe is in good working order and the config upgraded in a timely +manner. Abra supports convenient automation for recipe maintainenace, see the +"abra recipe upgrade", "abra recipe sync" and "abra recipe release" commands. `, Subcommands: []*cli.Command{ recipeListCommand,