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

managed_zone documentation update #61080

Open
wants to merge 3 commits into
base: devel
from

Conversation

@vince-lessbits
Copy link

commented Aug 22, 2019

SUMMARY

Add verbiage indicating the need for a dnsName key in the managed_zone dictionary if one doesn't register a resource from a gcp_dns_manged_zone task.

ISSUE TYPE
  • Docs Pull Request

+label: docsite_pr

SUMMARY
ISSUE TYPE
  • Bugfix Pull Request
  • Docs Pull Request
  • Feature Pull Request
  • New Module Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

managed_zone documentation update
##### SUMMARY
Add verbiage indicating the need for a `dnsName` key in the `managed_zone` dictionary if one doesn't register a resource from a gcp_dns_manged_zone task.


##### ISSUE TYPE
- Docs Pull Request

+label: docsite_pr
@ansibot

This comment has been minimized.

in two ways. First, you can place a dictionary with key ''name'' and value of
your resource''s name Alternatively, you can add `register: name-of-resource`
in two ways. First, you can place a dictionary with 2 keys: ''name'' and value of
your resource''s name, ''dnsName'' and the value of the DNS name manged by this zone

This comment has been minimized.

Copy link
@samccann

samccann Aug 22, 2019

Contributor
Suggested change
your resource''s name, ''dnsName'' and the value of the DNS name manged by this zone
your resource's name, ''dnsName'' and the value of the DNS name managed by this zone

This comment has been minimized.

Copy link
@samccann

samccann Aug 27, 2019

Contributor

you still need to get rid of the extra ` in resource``s above.

@ansibot ansibot removed the needs_triage label Aug 22, 2019

Update lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py
Co-Authored-By: Sandra McCann <samccann@redhat.com>
@ansibot

This comment has been minimized.

Copy link
Contributor

commented Aug 23, 2019

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

Command "ansible-doc -t module gcp_dns_resource_record_set" returned exit status 1.
>>> Standard Error
ERROR! module gcp_dns_resource_record_set missing documentation (or could not parse documentation): while parsing a block mapping
  in "<unicode string>", line 49, column 5
did not find expected key
  in "<unicode string>", line 53, column 21

The test ansible-test sanity --test docs-build [explain] failed with the error:

Command "/usr/bin/python3.6 /root/ansible/test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Command 'make singlehtmldocs' failed with status code: 2
--> Standard Output
PYTHONPATH=../../lib ../../hacking/build-ansible.py collection-meta --template-file=../templates/collections_galaxy_meta.rst.j2 --output-dir=rst/dev_guide/ ../../lib/ansible/galaxy/data/collections_galaxy_meta.yml
PYTHONPATH=../../lib ../../hacking/build-ansible.py document-config --template-file=../templates/config.rst.j2 --output-dir=rst/reference_appendices/ ../../lib/ansible/config/base.yml
mkdir -p rst/cli
PYTHONPATH=../../lib ../../hacking/build-ansible.py generate-man --template-file=../templates/cli_rst.j2 --output-dir=rst/cli/ --output-format rst ../../lib/ansible/cli/*.py
PYTHONPATH=../../lib ../../hacking/build-ansible.py document-keywords --template-dir=../templates --output-dir=rst/reference_appendices/ ./keyword_desc.yml
PYTHONPATH=../../lib ../../hacking/build-ansible.py document-plugins -t rst --template-dir=../templates --module-dir=../../lib/ansible/modules -o rst/modules/ 
Evaluating module files...
Makefile:99: recipe for target 'modules' failed
--> Standard Error
Traceback (most recent call last):
  File "../../hacking/build-ansible.py", line 88, in <module>
    main()
  File "../../hacking/build-ansible.py", line 79, in main
    retval = command.main(args)
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/plugin_formatter.py", line 711, in main
    plugin_info, categories = get_plugin_info(args.module_dir, limit_to=args.limit_to, verbose=(args.verbosity > 0))
  File "/root/ansible/hacking/build_library/build_ansible/command_plugins/plugin_formatter.py", line 225, in get_plugin_info
    doc, examples, returndocs, metadata = plugin_docs.get_docstring(module_path, fragment_loader, verbose=verbose)
  File "/root/ansible/lib/ansible/utils/plugin_docs.py", line 124, in get_docstring
    data = read_docstring(filename, verbose=verbose, ignore_errors=ignore_errors)
  File "/root/ansible/lib/ansible/parsing/plugin_docs.py", line 59, in read_docstring
    data[varkey] = AnsibleLoader(child.value.s, file_name=filename).get_single_data()
  File "/usr/local/lib/python3.6/dist-packages/yaml/constructor.py", line 41, in get_single_data
    node = self.get_single_node()
  File "ext/_yaml.pyx", line 707, in _yaml.CParser.get_single_node
  File "ext/_yaml.pyx", line 725, in _yaml.CParser._compose_document
  File "ext/_yaml.pyx", line 776, in _yaml.CParser._compose_node
  File "ext/_yaml.pyx", line 890, in _yaml.CParser._compose_mapping_node
  File "ext/_yaml.pyx", line 776, in _yaml.CParser._compose_node
  File "ext/_yaml.pyx", line 890, in _yaml.CParser._compose_mapping_node
  File "ext/_yaml.pyx", line 776, in _yaml.CParser._compose_node
  File "ext/_yaml.pyx", line 892, in _yaml.CParser._compose_mapping_node
  File "ext/_yaml.pyx", line 905, in _yaml.CParser._parse_next_event
yaml.parser.ParserError: while parsing a block mapping
  in "<unicode string>", line 49, column 5
did not find expected key
  in "<unicode string>", line 53, column 21
make: *** [modules] Error 1

The test ansible-test sanity --test package-data [explain] failed with the error:

Command "/usr/bin/python3.6 /root/ansible/test/sanity/code-smell/package-data.py" returned exit status 1.
>>> Standard Error
Traceback (most recent call last):
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 373, in <module>
    main()
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 350, in main
    sdist_path = create_sdist(tmp_dir)
  File "/root/ansible/test/sanity/code-smell/package-data.py", line 175, in create_sdist
    raise Exception('sdist was not created in the temp dir')
Exception: sdist was not created in the temp dir

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

lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E324 Argument 'state' in argument_spec defines default as ('present') but documentation defines default as (None)
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E326 Argument 'auth_kind' in argument_spec defines choices as (['machineaccount', 'serviceaccount', 'application']) but documentation defines choices as ([])
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E326 Argument 'state' in argument_spec defines choices as (['present', 'absent']) but documentation defines choices as ([])
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'auth_kind' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'env_type' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'managed_zone' in argument_spec defines type as 'dict' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'name' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'project' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'scopes' in argument_spec defines type as 'list' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'service_account_contents' in argument_spec defines type as 'jsonarg' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'service_account_email' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'service_account_file' in argument_spec defines type as 'path' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'state' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'target' in argument_spec defines type as 'list' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'ttl' in argument_spec defines type as 'int' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:0:0: E337 Argument 'type' in argument_spec defines type as 'str' but documentation doesn't define type
lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:82:21: E302 DOCUMENTATION is not valid YAML

The test ansible-test sanity --test yamllint [explain] failed with 1 error:

lib/ansible/modules/cloud/google/gcp_dns_resource_record_set.py:82:21: error DOCUMENTATION: syntax error: expected <block end>, but found '<scalar>'

click here for bot help

Put the double apostrophe back
Seems required to make the sanity checks pass

@ansibot ansibot added needs_rebase and removed small_patch labels Aug 27, 2019

@ansibot ansibot added the stale_ci label Sep 4, 2019

@dagwieers dagwieers added the docsite_pr label Sep 5, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.