Merge remote-tracking branch 'origin/main' into saschagrunert-suggestions

2022-05-17 08:45:13 -04:00
parent 9bd6349ed2 97a222b471
commit 3c923e7a44
34 changed files with 520 additions and 255 deletions
--- a/docs/CNAME
+++ b/docs/CNAME
@@ -0,0 +1 @@
+cli.urfave.org
--- a/docs/CODE_OF_CONDUCT.md
+++ b/docs/CODE_OF_CONDUCT.md
@@ -0,0 +1 @@
+../CODE_OF_CONDUCT.md
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -98,6 +98,28 @@ line help system which may be consulted for further information, e.g.:
 go run internal/genflags/cmd/genflags/main.go --help
 ```

+#### docs output
+
+The documentation in the `docs` directory is automatically built via `mkdocs` into a
+static site and published when releases are pushed (see [RELEASING](./RELEASING/)). There
+is no strict requirement to build the documentation when developing locally, but the
+following `make` targets may be used if desired:
+
+```sh
+# install documentation dependencies with `pip`
+make docs-deps
+```
+
+```sh
+# build the static site in `./site`
+make docs
+```
+
+```sh
+# start an mkdocs development server
+make serve-docs
+```
+
 ### pull requests

 Please feel free to open a pull request to fix a bug or add a feature. The @urfave/cli
--- a/docs/index.md
+++ b/docs/index.md
@@ -0,0 +1,21 @@
+# Welcome to urfave/cli
+
+[![GoDoc](https://godoc.org/github.com/urfave/cli?status.svg)](https://pkg.go.dev/github.com/urfave/cli/v2)
+[![codebeat](https://codebeat.co/badges/0a8f30aa-f975-404b-b878-5fab3ae1cc5f)](https://codebeat.co/projects/github-com-urfave-cli)
+[![Go Report Card](https://goreportcard.com/badge/urfave/cli)](https://goreportcard.com/report/urfave/cli)
+[![codecov](https://codecov.io/gh/urfave/cli/branch/main/graph/badge.svg)](https://codecov.io/gh/urfave/cli)
+
+`urfave/cli` is a simple, fast, and fun package for building command line apps in Go. The
+goal is to enable developers to write fast and distributable command line applications in
+an expressive way.
+
+These are the guides for each major supported version:
+
+- [`v2`](./v2/)
+- [`v1`](./v1/)
+
+In addition to the version-specific guides, these other documents are available:
+
+- [CONTRIBUTING](./CONTRIBUTING/)
+- [CODE OF CONDUCT](./CODE_OF_CONDUCT/)
+- [RELEASING](./RELEASING/)
--- a/docs/migrate-v1-to-v2.md
+++ b/docs/migrate-v1-to-v2.md
@@ -1,6 +1,4 @@
-Migration Guide: v1 to v2
-===
-
+# Migration Guide: v1 to v2

 v2 has a number of breaking changes but converting is relatively
 straightforward: make the changes documented below then resolve any
@@ -11,25 +9,6 @@ If you find any issues not covered by this document, please post a
 comment on [Issue 921](https://github.com/urfave/cli/issues/921) or
 consider sending a PR to help improve this guide.

-<!-- toc -->
-
-  * [Flags before args](#flags-before-args)
-  * [Import string changed](#import-string-changed)
-  * [Flag aliases are done differently](#flag-aliases-are-done-differently)
-  * [EnvVar is now a list (EnvVars)](#envvar-is-now-a-list-envvars)
-  * [Actions returns errors](#actions-returns-errors)
-  * [cli.Flag changed](#cliflag-changed)
-  * [Commands are now lists of pointers](#commands-are-now-lists-of-pointers)
-  * [Lists of commands should be pointers](#lists-of-commands-should-be-pointers)
-  * [Appending Commands](#appending-commands)
-  * [GlobalString, GlobalBool and its likes are deprecated](#globalstring-globalbool-and-its-likes-are-deprecated)
-  * [BoolTFlag and BoolT are deprecated](#booltflag-and-boolt-are-deprecated)
-  * [&cli.StringSlice{""} replaced with cli.NewStringSlice("")](#clistringslice-replaced-with-clinewstringslice)
-  * [Replace deprecated functions](#replace-deprecated-functions)
-  * [Everything else](#everything-else)
-
-<!-- tocstop -->
-
 # Flags before args

 In v2 flags must come before args. This is more POSIX-compliant.  You
--- a/docs/v1/index.md
+++ b/docs/v1/index.md
@@ -0,0 +1 @@
+manual.md
--- a/docs/v1/manual.md
+++ b/docs/v1/manual.md
@@ -1,35 +1,4 @@
-cli v1 manual
-===
-
-<!-- toc -->
-
- [Getting Started](#getting-started)
- [Examples](#examples)
-  * [Arguments](#arguments)
-  * [Flags](#flags)
-    + [Placeholder Values](#placeholder-values)
-    + [Alternate Names](#alternate-names)
-    + [Ordering](#ordering)
-    + [Values from the Environment](#values-from-the-environment)
-    + [Values from files](#values-from-files)
-    + [Values from alternate input sources (YAML, TOML, and others)](#values-from-alternate-input-sources-yaml-toml-and-others)
-    + [Precedence](#precedence)
-  * [Subcommands](#subcommands)
-  * [Subcommands categories](#subcommands-categories)
-  * [Exit code](#exit-code)
-  * [Combining short options](#combining-short-options)
-  * [Bash Completion](#bash-completion)
-    + [Enabling](#enabling)
-    + [Distribution](#distribution)
-    + [Customization](#customization)
-  * [Generated Help Text](#generated-help-text)
-    + [Customization](#customization-1)
-  * [Version Flag](#version-flag)
-    + [Customization](#customization-2)
-    + [Full API Example](#full-api-example)
-  * [Migrating to V2](#migrating-to-v2)
-
-<!-- tocstop -->
+# v1 guide

 ## Getting Started

--- a/docs/v2/index.md
+++ b/docs/v2/index.md
@@ -0,0 +1 @@
+manual.md
--- a/docs/v2/manual.md
+++ b/docs/v2/manual.md
@@ -1,52 +1,4 @@
-cli v2 manual
-===
-
-<!-- toc -->
-
- [Migrating From Older Releases](#migrating-from-older-releases)
- [Getting Started](#getting-started)
- [Examples](#examples)
-  * [Arguments](#arguments)
-  * [Flags](#flags)
-    + [Placeholder Values](#placeholder-values)
-    + [Alternate Names](#alternate-names)
-    + [Ordering](#ordering)
-    + [Values from the Environment](#values-from-the-environment)
-    + [Values from files](#values-from-files)
-    + [Values from alternate input sources (YAML, TOML, and others)](#values-from-alternate-input-sources-yaml-toml-and-others)
-    + [Required Flags](#required-flags)
-    + [Default Values for help output](#default-values-for-help-output)
-    + [Precedence](#precedence)
-  * [Subcommands](#subcommands)
-  * [Subcommands categories](#subcommands-categories)
-  * [Exit code](#exit-code)
-  * [Combining short options](#combining-short-options)
-  * [Bash Completion](#bash-completion)
-    + [Default auto-completion](#default-auto-completion)
-    + [Custom auto-completion](#custom-auto-completion)
-    + [Enabling](#enabling)
-    + [Distribution and Persistent Autocompletion](#distribution-and-persistent-autocompletion)
-    + [Customization](#customization)
-    + [ZSH Support](#zsh-support)
-    + [ZSH default auto-complete example](#zsh-default-auto-complete-example)
-    + [ZSH custom auto-complete example](#zsh-custom-auto-complete-example)
-    + [PowerShell Support](#powershell-support)
-  * [Generated Help Text](#generated-help-text)
-    + [Customization](#customization-1)
-  * [Version Flag](#version-flag)
-    + [Customization](#customization-2)
-  * [Timestamp Flag](#timestamp-flag)
-  * [Suggestions](#suggestions)
-  * [Full API Example](#full-api-example)
-
-<!-- tocstop -->
-
-## Migrating From Older Releases
-
-There are a small set of breaking changes between v1 and v2.
-Converting is relatively straightforward and typically takes less than
-an hour. Specific steps are included in
-[Migration Guide: v1 to v2](../migrate-v1-to-v2.md). Also see the [pkg.go.dev docs](https://pkg.go.dev/github.com/urfave/cli/v2) for v2 API documentation.
+# v2 guide

 ## Getting Started

@@ -1722,3 +1674,11 @@ func wopAction(c *cli.Context) error {
  return nil
 }
 ```
+
+## Migrating From Older Releases
+
+There are a small set of breaking changes between v1 and v2.
+Converting is relatively straightforward and typically takes less than
+an hour. Specific steps are included in
+[Migration Guide: v1 to v2](../migrate-v1-to-v2.md). Also see the [pkg.go.dev docs](https://pkg.go.dev/github.com/urfave/cli/v2) for v2 API documentation.
+