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

mention subcommands in every base page #6383

Merged
merged 21 commits into from
Sep 13, 2021

Conversation

marchersimon
Copy link
Collaborator

@marchersimon marchersimon commented Aug 18, 2021

Closes #6369
TODO:

  • de
    • ansible
    • aws
    • cargo
    • cradle
    • docker
    • dotnet
    • git
    • ip
    • choco
  • es
    • adb
    • docker
    • dotnet
  • fr
    • ansible
    • docker
    • git
    • pip
    • ip
    • pacman
  • id
    • adb
    • docker
    • git
    • pip
    • vue
  • it
    • adb
    • ansible
    • aws
    • az
    • cargo
    • conda
    • consul
    • cradle
    • docker
    • dotnet
    • git
    • dpkg
  • ja
    • choco
  • ko
    • adb
    • ansible
    • aws
    • az
    • cargo
    • conda
    • consul
    • cradle
    • docker
    • dotnet
  • ml
    • nmcli
    • pacman
  • nl
    • adb
    • cargo
    • git
  • pl
    • adb
    • aws
    • az
    • dotnet
    • vue
  • pt_BR
    • aws
    • docker
    • git
    • kubectl
    • dpkg
    • fc
    • choco
  • ru
    • adb
    • dotnet
  • tr
    • docker
  • zh
    • adb
    • ansible
    • docker
    • vue
    • btrfs
    • choco
    • reg
  • zh_TW
    • docker

To everyone who wants to help translating into their language: It would be enough to just comment the translation of

> Some subcommands such as `example command` have their own usage documentation.

here. Thanks!

@marchersimon marchersimon added documentation Issues/PRs modifying the documentation. page edit Changes to an existing page(s). mass changes Changes that affect multiple pages. translation Issues requesting translating pages from English to other languages. labels Aug 18, 2021
@marchersimon marchersimon added the help wanted You can help make tldr-pages better! label Aug 18, 2021
@sbrl
Copy link
Member

sbrl commented Aug 18, 2021

Cool!

Will review properly when it's not WIP.

@marchersimon
Copy link
Collaborator Author

English, German, and CONTRIBUTING.md are done. Just the translations are missing.

@marchersimon marchersimon mentioned this pull request Aug 18, 2021
6 tasks
Copy link
Collaborator

@navarroaxel navarroaxel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should add pacman

@marchersimon
Copy link
Collaborator Author

@navarroaxel pacman is already in the list 🤔

Co-authored-by: Axel Navarro <[email protected]>
@marchersimon
Copy link
Collaborator Author

marchersimon commented Aug 20, 2021

I translated all missing languages with deepl and Google translate:

  • fr: Cette commande dispose également d'une documentation sur ses sous-commandes, par exemple example command.
  • id: Perintah ini juga memiliki dokumentasi tentang sub-perintahnya, mis. example command.
  • it: Questo comando ha anche una documentazione sui suoi sottocomandi, ad esempio example command.
  • ja: このコマンドには、 example command のように、サブコマンドに関するドキュメントもあります。
  • ko: 이 명령에는 하위 명령에 대한 설명서도 있습니다. example command.
  • ml: ഈ കമാൻഡിൽ അതിന്റെ ഉപകമാൻഡുകളെക്കുറിച്ചുള്ള ഡോക്യുമെന്റേഷനും ഉണ്ട്, ഉദാ. example command.
  • nl: Dit commando heeft ook documentatie over zijn subcommando's, b.v. example command.
  • pl: Ta komenda ma również dokumentację o swoich podkomendach, np. example command.
  • pt_BR: Este comando também possui documentação sobre seus subcomandos, por exemplo, example command.
  • ru: Эта команда также имеет документацию о своих подкомандах, например, example command.
  • tr: Bu komut ayrıca alt komutları hakkında belgelere sahiptir, örn. example command.

Should we use those as backup if nobody helps translating or should be just leave them out?

@marchersimon
Copy link
Collaborator Author

@CleanMachine1
Copy link
Member

What about go, that has lots of different subcommands

@marchersimon
Copy link
Collaborator Author

That's why it's already in the list 🤔

@blueskyson
Copy link
Member

Here are Chinese translations:

  • zh: 此命令也有关于其子命令的文件,例如:example command.
  • zh_TW: 此命令也有關於其子命令的文件,例如:example command.

@reinhart1010
Copy link
Collaborator

Both translations also work well for Malay or Bahasa Malaysia, too.

@marchersimon
Copy link
Collaborator Author

Thanks @reinhart1010

Or even better to make the sentence active if allowed:

Sure, if it sounds better.

Some subcommands such as example command have their own usage documentation

I actually like that even more then the original 😆

Both translations also work well for Malay or Bahasa Malaysia, too.

So that would be id and ml right?

@reinhart1010
Copy link
Collaborator

ml stands for Malayalam (while Malay is represented by ms). Malayalam is just one of the many native languages in India, though (alongside Hindi and Tamil).

Oh, I didn't noticed that someone never wrote tldr-pages in Malay before.

…ork),98(power),961(sambashare),991(lp),998(wheel),1001(technik)
@marchersimon
Copy link
Collaborator Author

Whoops, the commit message should be add `id` 😂

@marchersimon
Copy link
Collaborator Author

@sbrl @navarroaxel what do you think about using Some subcommands such as example command have their own usage documentation as suggested by @ reinhart1010, instead of what we have now?

@CleanMachine1
Copy link
Member

That's why it's already in the list 🤔

Am I missing something, where is the english list and go-{{subcommands}} are not it in this list.

@marchersimon
Copy link
Collaborator Author

marchersimon commented Aug 26, 2021

Right here. And I didn't make an english list, because the english pages were already done.

@CleanMachine1
Copy link
Member

I didn't realize that this is a PR! Thats the problem.

@marchersimon marchersimon marked this pull request as ready for review September 3, 2021 17:37
@marchersimon
Copy link
Collaborator Author

I think we can merge this and move the list from above into a new issue.

@marchersimon marchersimon merged commit bd677b8 into tldr-pages:main Sep 13, 2021
@marchersimon marchersimon deleted the subcommand-mention branch September 13, 2021 08:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues/PRs modifying the documentation. help wanted You can help make tldr-pages better! mass changes Changes that affect multiple pages. page edit Changes to an existing page(s). translation Issues requesting translating pages from English to other languages.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refering to sub-command pages of a command
6 participants