{doc} Refine authoring commands doc #17236
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Juliehzl
requested review from
dbradish-microsoft,
jiasli and
qwordy
as code owners
|
doc |
qwordy
reviewed
Mar 9, 2021
qwordy
reviewed
Mar 9, 2021
qwordy
reviewed
Mar 9, 2021
Co-authored-by: Feiyue Yu <iamyfy@163.com>
Co-authored-by: Feiyue Yu <iamyfy@163.com>
Co-authored-by: Feiyue Yu <iamyfy@163.com>
| If your commands aren't showing with `az`, use `az --debug` to help debug. There could have been an exception | ||
| thrown whilst attempting to load your module. | ||
|
|
||
|
|
||
| <a name="heading_author_command_mod"></a>Authoring command modules | ||
| ------ | ||
| Currently, all command modules should start with `azure-cli-`. | ||
| When the CLI loads, it search for packages installed that start with that prefix. | ||
|
|
||
| The `example_module_template` directory gives an example command module with other useful examples. |
There was a problem hiding this comment.
The example_module_template directory no longer exists, right? This line can also be removed.
| ``` | ||
|
|
||
| Also, you can run `az` and if your command module contributes any commands, they should appear. | ||
| If your command module contributes any commands, they should appear with `az`. |
There was a problem hiding this comment.
Suggested change
| If your command module contributes any commands, they should appear with `az`. | |
| If your command module contributes any commands, they should appear when running `az`. |
Make it more clear with a verb.
| @@ -79,6 +63,10 @@ Command modules should have the following structure: | |||
| `-- HISTORY.rst | |||
| ``` | |||
|
|
|||
| You could create these files manually, or [create a module with `azdev cli create`](https://azurecliprod.blob.core.windows.net/videos/04%20-%20AzdevCliCreate.mp4). | |||
|
|
|||
| You could also consider using [Code-gen tool](https://azurecliprod.blob.core.windows.net/videos/04%20-%20AzdevCliCreate.mp4) to generate code automatically. | |||
There was a problem hiding this comment.
The link is not right for Code-gen.
Shall we move Code-gen above azdev cli create as it is more recommended now?
fengzhou-msft
approved these changes
Apr 9, 2021
qwordy
reviewed
Apr 9, 2021
| ``` | ||
|
|
||
| Also, you can run `az` and if your command module contributes any commands, they should appear. | ||
| If your command module contributes any commands, they should appear when running `az`. |
qwordy
reviewed
Apr 9, 2021
| cd azure-cli | ||
| virtualenv env | ||
| git clone https://github.com/Azure/azure-cli-extensions.git | ||
| python -m venv env | ||
| source env/bin/activate |
There was a problem hiding this comment.
You assume it is Linux environment.
There was a problem hiding this comment.
Yes. It is a simple example and for more information about setting up environment, link to https://github.com/Azure/azure-cli-dev-tools#setting-up-your-development-environment for details.
There was a problem hiding this comment.
Can you add a hint "This is script for Linux"?
qwordy
approved these changes
Apr 12, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Current doc page is out of date. Here is to adjust the doc with latest azure cli developer tooling.
Testing Guide
History Notes
[Component Name 1] BREAKING CHANGE: az command a: Make some customer-facing breaking change.
[Component Name 2] az command b: Add some customer-facing feature.
This checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.