From d5f49594a9f2a32ac3455ee9ca4cdf965636ea31 Mon Sep 17 00:00:00 2001 From: decentral1se Date: Sun, 5 Sep 2021 01:01:31 +0200 Subject: [PATCH] docs: attempt to simplify app/server/recipe CLI docs [ci skip] --- cli/app/app.go | 8 ++++---- cli/recipe/recipe.go | 12 +++--------- cli/server/server.go | 2 +- 3 files changed, 8 insertions(+), 14 deletions(-) diff --git a/cli/app/app.go b/cli/app/app.go index 2df4bba6..99a0827f 100644 --- a/cli/app/app.go +++ b/cli/app/app.go @@ -7,12 +7,12 @@ import ( // AppCommand defines the `abra app` command and ets subcommands var AppCommand = &cli.Command{ Name: "app", - Usage: "Manage your apps", + Usage: "Manage apps", ArgsUsage: "", Description: ` -This command provides all the functionality you need to manage the lifecycle of -your apps. From initial deployment to day-2 operations (e.g. backup/restore) to -scaling apps up and spinning them down. +This command provides all the functionality you need to manage the life cycle +of your apps. From initial deployment, day-2 operations (e.g. backup/restore) +to scaling apps up and spinning them down. `, Subcommands: []*cli.Command{ appNewCommand, diff --git a/cli/recipe/recipe.go b/cli/recipe/recipe.go index 52fdd717..9f3ebfd1 100644 --- a/cli/recipe/recipe.go +++ b/cli/recipe/recipe.go @@ -450,16 +450,10 @@ var recipeLintCommand = &cli.Command{ // RecipeCommand defines the `abra recipe` command and ets subcommands var RecipeCommand = &cli.Command{ Name: "recipe", - Usage: "Manage app recipes", + Usage: "Manage recipes", Description: ` -A recipe is a blueprint for an app. It is made up of two things: - -- A libre software app (e.g. Nextcloud, Wordpress, Mastodon) -- A package configuration which describes how to deploy and maintain it - -Recipes are developed, maintained and extended by the Co-op Cloud volunteer-run -community. Each recipe has a "level" which is intended as a way to quickly show -how reliable this app is to deploy and maintain in its current state. +A recipe is a blueprint for an app. It describes how to deploy and maintain an +app. `, Subcommands: []*cli.Command{ recipeListCommand, diff --git a/cli/server/server.go b/cli/server/server.go index 801e31f4..3dc647fa 100644 --- a/cli/server/server.go +++ b/cli/server/server.go @@ -8,7 +8,7 @@ import ( var ServerCommand = &cli.Command{ Name: "server", ArgsUsage: "", - Usage: "Manage the servers that host your apps", + Usage: "Manage servers", Description: ` Manage the lifecycle of a server.