docs: attempt to simplify app/server/recipe CLI docs [ci skip]

This commit is contained in:
decentral1se 2021-09-05 01:01:31 +02:00
parent 5287f097e7
commit d5f49594a9
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
3 changed files with 8 additions and 14 deletions

View File

@ -7,12 +7,12 @@ import (
// AppCommand defines the `abra app` command and ets subcommands // AppCommand defines the `abra app` command and ets subcommands
var AppCommand = &cli.Command{ var AppCommand = &cli.Command{
Name: "app", Name: "app",
Usage: "Manage your apps", Usage: "Manage apps",
ArgsUsage: "<app>", ArgsUsage: "<app>",
Description: ` Description: `
This command provides all the functionality you need to manage the lifecycle of This command provides all the functionality you need to manage the life cycle
your apps. From initial deployment to day-2 operations (e.g. backup/restore) to of your apps. From initial deployment, day-2 operations (e.g. backup/restore)
scaling apps up and spinning them down. to scaling apps up and spinning them down.
`, `,
Subcommands: []*cli.Command{ Subcommands: []*cli.Command{
appNewCommand, appNewCommand,

View File

@ -450,16 +450,10 @@ var recipeLintCommand = &cli.Command{
// RecipeCommand defines the `abra recipe` command and ets subcommands // RecipeCommand defines the `abra recipe` command and ets subcommands
var RecipeCommand = &cli.Command{ var RecipeCommand = &cli.Command{
Name: "recipe", Name: "recipe",
Usage: "Manage app recipes", Usage: "Manage recipes",
Description: ` Description: `
A recipe is a blueprint for an app. It is made up of two things: A recipe is a blueprint for an app. It describes how to deploy and maintain an
app.
- 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.
`, `,
Subcommands: []*cli.Command{ Subcommands: []*cli.Command{
recipeListCommand, recipeListCommand,

View File

@ -8,7 +8,7 @@ import (
var ServerCommand = &cli.Command{ var ServerCommand = &cli.Command{
Name: "server", Name: "server",
ArgsUsage: "<host>", ArgsUsage: "<host>",
Usage: "Manage the servers that host your apps", Usage: "Manage servers",
Description: ` Description: `
Manage the lifecycle of a server. Manage the lifecycle of a server.