Proper help text & new README structure #311

noerw · 2020-12-17T15:03:02Z

noerw commented

2020-12-17 15:03:02 +00:00

rework the help text output of tea, tea help, tea --help, now including a proper description, examples, about, ..
group commands by category in the help text
add a new (current) demo gif in README
replace the Usage section of the README with raw tea help output: IMO having a different text in the readme is a lame excuse to not ship good help in the binary.
remotely related: make tea --version output only the version, for enhanced parseability (breaking?)

let me know what you think

preview the new readme here

- rework the help text output of `tea`, `tea help`, `tea --help`, now including a proper description, examples, about, .. - group commands by category in the help text - add a new (current) demo gif in README - replace the `Usage` section of the README with raw `tea help` output: IMO having a different text in the readme is a lame excuse to not ship good help in the binary. - remotely related: make `tea --version` output **only** the version, for enhanced parseability (breaking?) let me know what you think preview the new readme [here](https://gitea.com/noerw/tea/src/branch/improve-app-help)

noerw added the

kind/docs

label 2020-12-17 15:03:02 +00:00

noerw added 8 commits 2020-12-17 15:03:02 +00:00

add cli.AppHelpTemplate for customization 946162b6fe

customize tea help view f8f31bb647

tea --version : improve parseability 9667984eb0

Rework README to include tea help output

It's an antipattern to have different help texts aimed at the same
users. So now that we have a good cli help text, lets use it here.
This eases maintenance, and at the same time gives an honest impression
on what we have to offer, while also encouraging to improve the internal
help text in the future.

I feel a bit sad for the GIF, but it was becoming outdated anyway..

e0d97450f9

group commands by category 1513d64a30

add new demo gif

shows the (probably) most useful workflow

4f401abc68

readme improvement a2ba019c7a

Merge branch 'master' into improve-app-help

continuous-integration/drone/pr Build is passing

Details

0e2ba56ab5

6543 reviewed 2020-12-17 17:36:44 +00:00

Dismissed

README.md

						
				@ -6,3 +6,2 @@

				Tea is a command line tool for interacting on one or more Gitea instances.

				It uses [code.gitea.io/sdk](https://code.gitea.io/sdk) and interacts with the Gitea API

				![demo gif](./demo.gif)

6543 commented

2020-12-17 17:36:44 +00:00

@techknowlogick can you update demo gif on dl.gitea.io with the gif of this pull?

6543 reviewed 2020-12-17 17:37:52 +00:00

Dismissed

README.md Outdated

						
				@ -10,1 +9,3 @@

				![demo gif](https://dl.gitea.io/screenshots/tea_demo.gif)

				```

				   tea - command line tool to interact with Gitea

				   version 0.6.0+17-g1c10f33

6543 commented

2020-12-17 17:37:52 +00:00

version 0.7.0 preview ... or so (should be changed on release)

noerw marked this conversation as resolved

6543 reviewed 2020-12-17 17:40:43 +00:00

Dismissed

main.go Outdated

						
				@ -60,1 +67,4 @@

				}

				var appDescription = `tea is a productivity helper for Gitea.  It can be used to manage most entities on one

				or multiple Gitea instances, and also provides local helpers like 'tea pull checkout'.

6543 commented

2020-12-17 17:40:43 +00:00

-or multiple Gitea instances, and also provides local helpers like 'tea pull checkout'.
+or multiple Gitea instances and provides local helpers like 'tea pull checkout'.

```diff -or multiple Gitea instances, and also provides local helpers like 'tea pull checkout'. +or multiple Gitea instances and provides local helpers like 'tea pull checkout'.

noerw marked this conversation as resolved

noerw added 1 commit 2020-12-17 19:13:32 +00:00

code review

continuous-integration/drone/pr Build is passing

Details

78c94edaae

noerw added 1 commit 2020-12-17 19:24:57 +00:00

Merge branch 'master' into improve-app-help

continuous-integration/drone/pr Build is passing

Details

d9124476b7

lunny reviewed 2020-12-18 04:14:56 +00:00

Dismissed

README.md Outdated

						
				@ -29,41 +91,6 @@ brew tap gitea/tap https://gitea.com/gitea/homebrew-gitea

				brew install tea

lunny commented

2020-12-18 04:14:56 +00:00

I'd like to add ### macOS before these lines and also move them before alphinelinux since this is an official one.

I'd like to add `### macOS` before these lines and also move them before alphinelinux since this is an official one.

noerw marked this conversation as resolved

lunny approved these changes 2020-12-18 04:17:00 +00:00

Dismissed

lunny left a comment

Otherwise LGTM

khmarbaise approved these changes 2020-12-18 06:53:49 +00:00

Dismissed

README.md

						
				@ -4,3 +4,3 @@

				## The official CLI interface for gitea

				### the official CLI for gitea

khmarbaise commented

2020-12-18 06:51:49 +00:00

I would suggest to use ### The official CLI for gitea instead.

I would suggest to use `### The official CLI for gitea` instead.

noerw marked this conversation as resolved

noerw added 1 commit 2020-12-18 07:36:18 +00:00

restructure installation section

continuous-integration/drone/pr Build is passing

Details

2c6c4dbb0a

lunny merged commit 43a58bdba1 into master

2020-12-21 13:37:21 +00:00

lunny referenced this issue from a commit

2020-12-21 13:37:21 +00:00

Proper help text & new README structure (#311)

noerw deleted branch improve-app-help

2020-12-21 13:40:50 +00:00

Sign in to join this conversation.

No reviewers

No Milestone

No Assignees

4 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: gitea/tea#311

				`@ -29,41 +91,6 @@ brew tap gitea/tap https://gitea.com/gitea/homebrew-gitea`
				`brew install tea`