Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation for this to tldr-pages; anything you'd like to change? #98

Closed
artemislena opened this issue Apr 14, 2021 · 6 comments

Comments

@artemislena
Copy link

I didn't really find any other way to contact you, so I decided to open an issue here instead… I opened a PR at tldr-pages/tldr#5757 to add documentation for Minisign to tldr. If there's anything you'd like to change or add about it, you might want to have a look over there.

@jedisct1
Copy link
Owner

This is neat! Thanks for submitting that PR!

Maybe also add an example where the public key is provided on the command line for verification?

minisign -P <base64 encoded public key> -Vm <file>

Maybe not if you think this is too much. But this is probably the most common way to do verification as the entire command can be copy/pasted from a project's documentation, and verification can be immediately done without requiring a public key file.

artemislena added a commit to artemislena/tldr that referenced this issue Apr 14, 2021
@artemislena
Copy link
Author

artemislena commented Apr 14, 2021

Alright, sounds fair; just did that. I don't think that's too much ‒ 4 to 8 examples are allowed, I was at four, so a fifth won't hurt, I guess. Should this issue be closed now or is there anything else you'd like to add?

@bl-ue
Copy link

bl-ue commented Apr 14, 2021

@FantasyCookie17 let me me a correction: not 4 to 8, but 1 to 8 are allowed ;)

@artemislena
Copy link
Author

artemislena commented Apr 14, 2021

Oh 😸 I must've misremembered something then. For reference:

Try to keep pages at around 5 examples. Pages can be longer if needed, but don't exceed 8 examples. Remember, it's OK if the page doesn't cover everything; that's what man is for.

https://github.com/tldr-pages/tldr/blob/master/CONTRIBUTING.md

@bl-ue
Copy link

bl-ue commented Apr 14, 2021

Hmm, that should be updated. 89 of our 2377 English pages (3.7%) have only one example.

In case you're interested...

@artemislena
Copy link
Author

Since the conversation moved over to the tldr repo, I'm closing this for now.

Waples pushed a commit to tldr-pages/tldr that referenced this issue Apr 18, 2021
* Added English and German pages for Minisign

* Fixed typo

* Fixed the remaining typos

* Apply suggestions by bl-ue

* Forgot to add English page to last commit

* Change description to official description

* Add suggestion by jedisct1; see jedisct1/minisign#98

* Apply changes requested by bl-ue

* Patch German translation

* Forgot "encoded"

* Make order of flags more consistent as suggested by jedisct1

* Forgot to add German translation in last commit

* Use relative instead of absolute paths

* Shorten comments

* Change German translations to imperative

* Fix spelling mistake

* Use imperative in German translation in all commands

* Use Umlaute in German translation even in arguments

* Use 'ü' in 'schluessel'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants