keybase-gpg-github icon indicating copy to clipboard operation
keybase-gpg-github copied to clipboard

Examples should be with placeholders

Open singuerinc opened this issue 7 years ago • 3 comments

Sometimes people just copy/paste examples/documentation. Maybe is better to put a note or a placeholder.

Example:

$ git config --global user.signingkey [KEY-ID-HERE]
$ git config --global commit.gpgsign true

singuerinc avatar Aug 16 '16 08:08 singuerinc

I'm not sure whether this would make it more complicated.

pstadler avatar Aug 16 '16 09:08 pstadler

Why not just leverage environmental variables where it would be the most helpful, like long output, and have a setup script that simply exports them. That way the examples can just look like this.


Example:

$ # assuming you exported the variables from before…
$ git config --global user.signingkey $KEY_ID_HERE
$ git config --global commit.gpgsign true

rogeruiz avatar Feb 04 '17 02:02 rogeruiz

That would make more sense, PRs welcome.

pstadler avatar Feb 04 '17 10:02 pstadler