coop-cloud/abra
coop-cloud
/
abra
5
2
Fork 15
Code Issues Pull Requests 4 Packages Releases 36 Activity

docs: improved recipe maintainer docs

This commit is contained in:
decentral1se 2021-12-20 00:15:42 +01:00
parent bf82bc9c7f
commit 398deec272
Signed by: decentral1se
GPG Key ID: 03789458B3D0C410
2 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cli/catalogue/catalogue.go
View File

@ -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. // CatalogueCommand defines the `abra catalogue` command and sub-commands.
var CatalogueCommand = &cli.Command{ var CatalogueCommand = &cli.Command{
Name: "catalogue", Name: "catalogue",
Usage: "Manage the recipe catalogue (for maintainers)", Usage: "Manage the recipe catalogue",
Aliases: []string{"c"}, Aliases: []string{"c"},
ArgsUsage: "<recipe>", ArgsUsage: "<recipe>",
Description: "This command helps recipe packagers interact with the recipe catalogue", Description: "This command helps recipe packagers interact with the recipe catalogue",

9
cli/recipe/recipe.go
View File

@ -7,13 +7,18 @@ import (
// RecipeCommand defines all recipe related sub-commands. // RecipeCommand defines all recipe related sub-commands.
var RecipeCommand = &cli.Command{ var RecipeCommand = &cli.Command{
Name: "recipe", Name: "recipe",
Usage: "Manage recipes (for maintainers)", Usage: "Manage recipes",
ArgsUsage: "<recipe>", ArgsUsage: "<recipe>",
Aliases: []string{"r"}, Aliases: []string{"r"},
Description: ` 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 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. 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{ Subcommands: []*cli.Command{
recipeListCommand, recipeListCommand,