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

Update azure_rm_virtualmachine related document #58861

Merged
merged 8 commits into from Jul 16, 2019

Conversation

Projects
None yet
4 participants
@Fred-sun
Copy link
Contributor

commented Jul 9, 2019

SUMMARY

Update azure_rm_virtualmachine related document.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

azure_rm_virtualmachine/azure_rm_virtualmachine_facts

ADDITIONAL INFORMATION

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jul 9, 2019

@Fred-sun, just so you are aware we have a dedicated Working Group for azure.
You can find other people interested in this in #ansible-azure on Freenode IRC
For more information about communities, meetings and agendas see https://github.com/ansible/community

click here for bot help

@Fred-sun

This comment has been minimized.

Copy link
Contributor Author

commented Jul 10, 2019

ready_for_review

@acozine
Copy link
Contributor

left a comment

This module has a lot of parameters, making it tricky to document. This PR is a good start - thanks @Fred-sun. I found some areas for improvement, and would like to review it again before merging.

@acozine acozine removed the needs_triage label Jul 11, 2019

@Fred-sun

This comment has been minimized.

Copy link
Contributor Author

commented Jul 15, 2019

ready_for_review

@nitzmahone
Copy link
Member

left a comment

couple minor tweaks

@ansibot

This comment has been minimized.

Copy link
Contributor

commented Jul 15, 2019

The test ansible-test sanity --test ansible-doc --python 2.6 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected string or Unicode, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 2.7 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected string or Unicode, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 3.5 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected str instance, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 3.6 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected str instance, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 3.7 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected str instance, AnsibleMapping found

The test ansible-test sanity --test ansible-doc --python 3.8 [explain] failed with the error:

Command "ansible-doc -t module azure_rm_virtualmachine azure_rm_virtualmachine_facts" returned exit status 250.
>>> Standard Error
ERROR! Unexpected Exception, this is probably a bug: sequence item 5: expected str instance, AnsibleMapping found

The test ansible-test sanity --test docs-build [explain] failed with 3 errors:

docs/docsite/rst/modules/list_of_all_modules.rst:363:0: undefined-label: undefined label: azure_rm_virtualmachine_module (if the link has no caption the label must precede a section header)
docs/docsite/rst/modules/list_of_cloud_modules.rst:374:0: undefined-label: undefined label: azure_rm_virtualmachine_module (if the link has no caption the label must precede a section header)
docs/docsite/rst/porting_guides/porting_guide_2.4.rst:94:0: undefined-label: undefined label: azure_rm_virtualmachine_module (if the link has no caption the label must precede a section header)

The test ansible-test sanity --test pep8 [explain] failed with 4 errors:

lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:31:161: E501 line too long (178 > 160 characters)
lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:111:161: E501 line too long (233 > 160 characters)
lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:116:161: E501 line too long (177 > 160 characters)
lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:362:161: E501 line too long (196 > 160 characters)

The test ansible-test sanity --test validate-modules [explain] failed with 3 errors:

lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:0:0: E305 DOCUMENTATION.description.5: expected str @ data['description'][5]. Got {'List of Linux images with cloud-init enabled': 'U(https://docs.microsoft.com/en-us/azure/virtual-machines/linux/using-cloud-init#cloud-init-overview).'}
lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:0:0: E305 DOCUMENTATION.description.6: expected str @ data['description'][6]. Got {'To enable cloud-init on other Linux images': 'U(https://docs.microsoft.com/en-us/azure/virtual-machines/linux/cloudinit-prepare-custom-image).'}
lib/ansible/modules/cloud/azure/azure_rm_virtualmachine.py:0:0: E326 Argument 'remove_on_absent' in argument_spec defines choices as ([]) but documentation defines choices as ([['all'], ['all_autocreated'], ['network_interfaces'], ['virtual_storage'], ['public_ips']])

click here for bot help

@acozine acozine merged commit 6430205 into ansible:devel Jul 16, 2019

1 check passed

Shippable Run 132198 status is SUCCESS.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.