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.

Sign up for GitHub

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

Jump to bottom

[docs] Do not include individual names in docs #749

Closed
ahmetb opened this issue Aug 25, 2016 · 3 comments
Closed

[docs] Do not include individual names in docs #749

ahmetb opened this issue Aug 25, 2016 · 3 comments
Assignees
@yugangw-msft
Milestone
Sprint 2

Comments

@ahmetb
Copy link
Contributor

ahmetb commented Aug 25, 2016 •
edited
Loading 

~ az vm extension set -h

[...]

Examples
    Add a new linux user
        az vm extension set -n VMAccessForLinux --publisher Microsoft.OSTCExtensions --version 1.4
        --vm-name myvm --resource-group yugangw --private-config '{"username":"user1",
        "ssh_key":"ssh_rsa ..."}'
``

I'm a bit against this stuff. The docs can be a little bit more generic/formal.
@mayurid mayurid added this to the Sprint 2 milestone Aug 26, 2016
@mayurid
Copy link
Member

mayurid commented Aug 26, 2016

Agreed. @yugangw-msft to look at it

@johanste
Copy link
Member

Is it a goal that the example should be executable exactly as shown in the help? If not, one option is to use something like as the notation for the actual value.

@yugangw-msft
Copy link
Contributor

I just forgot to remove all individual names when I pasted a command to the help doc. I did change the vm name though.

yugangw-msft added a commit to yugangw-msft/azure-cli that referenced this issue Aug 29, 2016
@yugangw-msft
VM issue: fix Azure#749, Azure#753, Azure#575
5648f00
johanste added a commit that referenced this issue Aug 31, 2016
@johanste
Provide support for reading a single parameter value from file (#738)
ceff1c4 
* Provide support for reading a single parameter value from file

Values prefixed with @ will be replaced with the content of the file immediately following the @-sign.

The pseudo-name '-' is used to indicate stdin.

* Fix accidentally deleted space (which made pylint angry)

* enable diagnostics and extensions in vmss profile (#737)

* Expose generic update parameters on existing custom updates (#735)

* Convert all updates to cli_generic_update_commands.

* Code review fixes.

* Remove inline CliArgumentType(...) registrations (#744)

* Eliminates anti-pattern of creating CliArgumentTypes inline during parameter registration.

* Minor fixes.

* Add NAT Rules to VMSS create that allow SSH/RDP by default (#743)

* Update regular expression to fix issue #147 (#747)

* Support colored output on Windows (#756)

* [Help] Help Fixes and Enhancements (#736)

* Fix issue #680.

* Initial version of help dump. Logic to extract summary.

* Fix issues #365 and #447.

* Code review fixes.

* Code review fixes.

* Fix folded parameter logic to make new optional. Update existing uses to (#766)

work with new logic.

* Treat CloudError like a CLIError (don't print stack trace) (#759)

* 'az configure' experience (default output format) (#739)

* 'az configure' experience

- Allows user to set default output type.
- Infrastructure for CLI configurations also implemented.

* Add license header & fix deprecated method

* Wrap SafeConfigParser instead of extending from it

* Code review feedback changes

* Table format revisions (#748)

* Table format revisions

- Table output is generic and automatically extracts fields from the result.
- No longer use simple_output_query as it was specific for commands and as packages will support multiple API versions, this solution is no longer feasible.

* Support callable again for table format after discussion

When a callable is set for a command, it will be used as long as there is no query active.
If there's a query active, the callable will not be used so the user has to specify a full query that can generate an appropriate table.

* Remove 'starting' message for long running operations (#767)

* Remove 'starting' message for long running operations

* Change name of poll_interval_ms as ambiguous and also change logger messages that referred to this interval

* Catch EOF to minimize stack trace craziness. (#768)

* Change simple_output_query to be table_transformer (#771)

* [Resource] Resource Tag Fix (issue 763) (#765)

* Use 'ignore_type' within resource module. Fix issue 763.

* Code review fixes.

* Only delete certain files in yml output folder during Document CI (#762)

* Update README Docker instructions. (#776)

* Fixes #772 (#779)

* Handle BrokenPipeError (#775)

* Fix issue 770.

* Fix undeclared-variable

* update a few command descriptions (#781)

* VM issue: fix #749, #753, #575 (#778)

* Add commands for Azure IoT (#730)

* Add commands for Azure IoT

* 1.Include files into azure-cli.pyproj; 2. Update license info in setup.py

* add missing pylint directive

* resolve review comments

* resolve comments

* fix typo

* [Document CI] Handle Robocopy exit code (#786)

* Generic Update enhancements. (#740)

* Fix issues #728 and #686

* Code review fixes.

* Fix Error if Non-existent Storage Account Specified (#787)

* Fix issue #784.

* Code review fix.

* vm: enable autoUpgradeMinorVersion by default (#791)

* cmd: use plurals for list-* command naming (#792)

Committer: yugangw-msft

* Ensure docstring help with unrecognized unicode characters still displays correctly. (#795)

* Provide support for reading a single parameter value from file

Values prefixed with @ will be replaced with the content of the file immediately following the @-sign.

The pseudo-name '-' is used to indicate stdin.

* Fix accidentally deleted space (which made pylint angry)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yugangw-msft yugangw-msft

Labels
None yet
Projects
None yet
Milestone
Sprint 2
Development

No branches or pull requests
4 participants
@ahmetb @mayurid @yugangw-msft @johanste