magento/graphql-ce#: Magento CLI. Support short commands name

[atwixfirster]

Purpose of this pull request

This pull request (PR) adds information about short CLI command format.

Affected DevDocs pages

• https://devdocs.magento.com/guides/v2.1/reference/cli/magento.html
• https://devdocs.magento.com/guides/v2.2/reference/cli/magento.html
• https://devdocs.magento.com/guides/v2.3/reference/cli/magento.html

Links to Magento source code

• Symfony\Component\Console\Application::find()

[devops-devdocs]

An admin must run tests on this PR before it can be merged.

[dshevtsov]

Technical: If we are telling readers that some commands are available using shortcuts, it makes sense to provide a full list of all available shortcuts. This topic is generated from the output of the bin/magento list command, so it would be great to have those shortcuts in the generated list as well that requires changing the Magento CLI itself.
Otherwise, we can confuse people providing information that the shortcuts are available, but they should guess about available options.

I'd suggest to contribute to the magento/magento2 codebase creating a feature request or even a PR.

Editorial:

1. Notes should be tagged with {: .bs-callout-info } class.
2. Consider using Google Developer Documentation Style Guide in cases when the DevDocs Style Guide doesn't give clear guidelines:

• Politeness and use of "please"
• Consider changing via to using. Refer to https://developers.google.com/style/word-list#letter-V

[atwixfirster]

Thank you, for your review @dshevtsov .

Technical: If we are telling readers that some commands are available using shortcuts, it makes sense to provide a full list of all available shortcuts.

Honestly, I thought about that. However, for example, for the bin/magento setup:upgrade command there are a lot of shortcuts combinations:

• bin/magento s:up
• bin/magento s:upg
• bin/magento s:upgr
• bin/magento s:upgra
• bin/magento s:upgrad
• bin/magento se:up
• bin/magento se:upg
• bin/magento se:upgr
• bin/magento se:upgra
• bin/magento se:upgrad
• bin/magento set:up
• bin/magento set:upg
• bin/magento set:upgr
• bin/magento set:upgra
• bin/magento set:upgrad
• bin/magento setu:up
• bin/magento setu:upg
• bin/magento setu:upgr
• bin/magento setu:upgra
• bin/magento setu:upgrad
• bin/magento setup:up
• bin/magento setup:upg
• bin/magento setup:upgr
• bin/magento setup:upgra
• bin/magento setup:upgrad

All of them are the bin/magento setup:upgrade shortcuts. Let's imagine if we add all this stuff into DevDocs tutorial.....

Editorial:

1. Notes should be tagged with {: .bs-callout-info } class.

done

Politeness and use of "please"

fixed

Consider changing via to using. Refer to https://developers.google.com/style/word-list#letter-V

removed

Thank you!

[dshevtsov]

I see your point @atwixfirster. Seems like this is a Symphony feature.
Then, we should merely add to the note a link to the Symphony documentation that should be enough for general understanding of how to use shortcuts with any Magento CLI command.

[atwixfirster]

Then, we should merely add to the note a link to the Symphony documentation that should be enough for general understanding of how to use shortcuts with any Magento CLI command.

added

Thank you, @dshevtsov

[erikmarr]

Looks good! Just a minor wording suggestion.

[erikmarr]

Suggested change

	Magento CLI allows a short command name instead of a full one. For example, `bin/magento setup:upgrade` can be called using `bin/magento s:up`, `bin/magento s:upg`, etc. See [shortcut syntax](https://symfony.com/doc/current/components/console/usage.html#shortcut-syntax) to understand how to use shortcuts with any Magento CLI command.
	You can call Magento CLI commands using shortcuts instead of the full command name. For example, you can call `bin/magento setup:upgrade` using `bin/magento s:up`, `bin/magento s:upg`, etc. See [shortcut syntax](https://symfony.com/doc/current/components/console/usage.html#shortcut-syntax) to understand how to use shortcuts with any Magento CLI command.

[atwixfirster]

done

Thank you, @erikmarr

[dshevtsov]

running tests

[ghost]

Hi @atwixfirster, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

[meker12]

@dshevstov and @erikmarr Just confirming that you don't want to call this update out in What's New.

[dshevtsov]

@meker12, no.