Help authoring doc with examples and recommended authoring guidelines.#600
Merged
BurtBiel merged 1 commit intoAzure:masterfrom Aug 3, 2016
Merged
Help authoring doc with examples and recommended authoring guidelines.#600BurtBiel merged 1 commit intoAzure:masterfrom
BurtBiel merged 1 commit intoAzure:masterfrom
Conversation
|
Hi @BurtBiel, I'm your friendly neighborhood Azure Pull Request Bot (You can call me AZPRBOT). Thanks for your contribution! TTYL, AZPRBOT; |
doc/authoring_help.md
Outdated
Member
There was a problem hiding this comment.
The backslash is causing some chars to be escaped when the doc is formatted. Consider using / instead as it would align more with Linux users. #Resolved
Member
|
🕐 #Resolved |
3b5be62 to
4127dcd
Compare
Contributor
Author
|
@derekbekoe comments addressed In reply to: 237295359 [](ancestors = 237295359) |
Member
|
|
| | YAML Authoring | | ||
| | Code Specified | | ||
| | Docstring | | ||
| | SDK Text | No newline at end of file |
Member
There was a problem hiding this comment.
Docstring and SDK Text are really the same thing because the SDK text is a docstring. #WontFix
Contributor
Author
There was a problem hiding this comment.
I was thinking here that we may wrap an SDK call in a custom command, in which case a docstring on the wrapper would override the SDK docstring. I think it's worthwhile to call out the SDK strings as separate from the product docstrings since they can't be changed.
In reply to: 73391384 [](ancestors = 73391384)
Contributor
|
|
|
|
||
| Commands without YAML usually still have help text. Where does it come from? These sections briefly outline where Az help text comes from. | ||
|
|
||
| Authoring note: it is not recommended to use the product code to author command/group help--YAML is the recommended way (see above). This information is provided for completeness and may be useful for fixing small typos in existing help text. |
Contributor
There was a problem hiding this comment.
Just for clarification, does this mean the help text in register_cli_argument is also not recommended. I thought that is a nice data-driven approach.
The rest look good to me. #ByDesign
Contributor
Author
There was a problem hiding this comment.
for quick documentation, using the register help= format is fine. If the whole/most of the command needs its help to be re-written, we're better off unifying the help into a single YAML string rather than registering each param just to add the help tag to it.
In reply to: 73418361 [](ancestors = 73418361)
00Kai0
pushed a commit
to 00Kai0/azure-cli
that referenced
this pull request
Apr 7, 2021
00Kai0
pushed a commit
to 00Kai0/azure-cli
that referenced
this pull request
Apr 7, 2021
* NFSAAS-2102 update to R3.5 (Azure#29) * Nfsaas 2102 update to r3 5 (Azure#30) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * Nfsaas 2102 update to r3 5 (Azure#31) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#32) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#33) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#34) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#35) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#36) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#37) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#38) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#39) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#40) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Merge azure master back to fork. (Azure#41) * Add new version of aks-preview in index.json (Azure#634) * Azure Event Grid 0.4.1 (Azure#633) * Azure Event Grid 0.4.1 * fix white space * fix style issues * style fixes * style comment spaces fixes * more style fixes * mossing hesder * Address CR comment * move json generated SDK files to vendored_sdks folder and update related imports * revert index changes until we publish final extension * Address CR comments by removing unnecessary parameters * Fix style * update index.json file * fix index.json after running azdev extension update-index * fix index.json after running azdev extension update-index * add missing __init__.py * fix init files * fix new line in init files * update location of vendored_sdks and update index.json * fix help errors and update index.json file accordingly * [aks-preview]: fix python3-only super() syntax (Azure#641) * [storage-preview] release azcopy 10.0.9 (Azure#639) * [storage-preview] release azcopy 10.0.9 * Fix indent * [storage-preview] pulish 0.2.4 (Azure#642) * App Insights control plane (Azure#600) * Remove 'preview' from Dev Spaces (Azure#638) * Update PULL_REQUEST_TEMPLATE.md (Azure#645) Refer to azdev. * setting default vm size for windows (Azure#637) * SQL: make "up" command work end to end (Azure#644) * Update requirements.txt Bump for Jinja security vulnerability
00Kai0
pushed a commit
to 00Kai0/azure-cli
that referenced
this pull request
Apr 7, 2021
* [image-copy] update to version 0.2.0 * [image-copy] update index for version 0.2.0 * switch to 2019-04-01 api version and enable windows agent pool (Azure#612) * fixing az support for agent pools and mc * vendor in 2019-04-01 SDK * enableing windows profile * merge the latest official SDK * add secure prompt for windows admin password * fixing warnings * Policies should be global, remove location parameter and default it (Azure#620) * bug fixes: missing service principal and network profile parameter validation (Azure#626) * Pin max CLI version. (Azure#630) * Update front door index to 0.1.5 (Azure#632) * Fixes Azure#629. (Azure#631) * Update index.json. (Azure#640) * Add new version of aks-preview in index.json (Azure#634) * Azure Event Grid 0.4.1 (Azure#633) * Azure Event Grid 0.4.1 * fix white space * fix style issues * style fixes * style comment spaces fixes * more style fixes * mossing hesder * Address CR comment * move json generated SDK files to vendored_sdks folder and update related imports * revert index changes until we publish final extension * Address CR comments by removing unnecessary parameters * Fix style * update index.json file * fix index.json after running azdev extension update-index * fix index.json after running azdev extension update-index * add missing __init__.py * fix init files * fix new line in init files * update location of vendored_sdks and update index.json * fix help errors and update index.json file accordingly * [aks-preview]: fix python3-only super() syntax (Azure#641) * [storage-preview] release azcopy 10.0.9 (Azure#639) * [storage-preview] release azcopy 10.0.9 * Fix indent * [storage-preview] pulish 0.2.4 (Azure#642) * App Insights control plane (Azure#600) * Remove 'preview' from Dev Spaces (Azure#638) * Update PULL_REQUEST_TEMPLATE.md (Azure#645) Refer to azdev. * setting default vm size for windows (Azure#637) * SQL: make "up" command work end to end (Azure#644) * Update requirements.txt Bump for Jinja security vulnerability * Update to RP standard release 3.5 (Azure#29) (Azure#627) * NFSAAS-2102 update to R3.5 (Azure#29) * Nfsaas 2102 update to r3 5 (Azure#30) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * Nfsaas 2102 update to r3 5 (Azure#31) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#32) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#33) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#34) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#35) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#36) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#37) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#38) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#39) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Nfsaas 2102 update to r3 5 (Azure#40) * NFSAAS-2102 update to R3.5 * NFSAAS-2102 update to RP R3.5 standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * NFSAAS-2102 update to R3.5 RP standard * Merge azure master back to fork. (Azure#41) * Add new version of aks-preview in index.json (Azure#634) * Azure Event Grid 0.4.1 (Azure#633) * Azure Event Grid 0.4.1 * fix white space * fix style issues * style fixes * style comment spaces fixes * more style fixes * mossing hesder * Address CR comment * move json generated SDK files to vendored_sdks folder and update related imports * revert index changes until we publish final extension * Address CR comments by removing unnecessary parameters * Fix style * update index.json file * fix index.json after running azdev extension update-index * fix index.json after running azdev extension update-index * add missing __init__.py * fix init files * fix new line in init files * update location of vendored_sdks and update index.json * fix help errors and update index.json file accordingly * [aks-preview]: fix python3-only super() syntax (Azure#641) * [storage-preview] release azcopy 10.0.9 (Azure#639) * [storage-preview] release azcopy 10.0.9 * Fix indent * [storage-preview] pulish 0.2.4 (Azure#642) * App Insights control plane (Azure#600) * Remove 'preview' from Dev Spaces (Azure#638) * Update PULL_REQUEST_TEMPLATE.md (Azure#645) Refer to azdev. * setting default vm size for windows (Azure#637) * SQL: make "up" command work end to end (Azure#644) * Update requirements.txt Bump for Jinja security vulnerability * Update readme to reflect the latest SQL DB status * SQL up: update a typo * Update index.json for backwards compatability for Dev Spaces (Azure#648) * update index.json for backwards compatability * fix maxCliVersion for dev-spaces-preview * revert dev-spaces minCliCoreVersion * update metadata for dev-spaces and dev-spaces-preview * update metadata for dev-spaces and dev-spaces-preview * sync workspaces * 0.5.0 release for Azure DevOps (Azure#653) * [AKS]customizing node resource group (Azure#636) * customizing node resource group * make 2.0 and 3.0 python work * add index * Onboard Azure Machine Learning Service CLI (Azure#655) * [storage-preview] pulish 0.2.5 (Azure#657) * [AKS] Add Azure policy addon (Azure#651) * Add the Azure Policy Addon Support * Add azure-policy addon * Allow azure-policy addon in create * Update the index * Add the missing parameter description * 0.6.0 release for Azure DevOps (Azure#660) * Upgrade AppConfig extension version from 0.4.0 to 0.5.0 (Azure#661) * Upgrade AppConfig extension verstion from 0.4.0 to 0.5.0 * format downloadUrl * update wheel version to 0.30.0 * Update service principal secret for windows nodes (Azure#662) * Release storage-preview 0.2.5 (Azure#663) * Remove extra + (Azure#664) * 0.7.0 release for Azure DevOps (Azure#666) * 0.7.0 release for Azure DevOps * update sha * fix * remove botservice from index.json (Azure#667) * [image-copy] fix temp_rg default valuet
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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.
No description provided.