equinix-labs / ansible-collection-equinix

Ansible content to help automate the management of Equinix resources
https://deploy.equinix.com/labs/ansible-collection-equinix/
GNU General Public License v3.0
2 stars 8 forks source link

Update metal_device.md and possibly other module docs to include metal_api_token parameter #167

Open dmc5179 opened 3 months ago

dmc5179 commented 3 months ago
SUMMARY

The metal_device module parameter description does not include the metal_api_token parameter.

I did not edit the file on github directly because it appears some or all of the documentation is generated by the build process.

ISSUE TYPE
COMPONENT NAME

metal_device.md

ANSIBLE VERSION
ansible --version
ansible [core 2.14.11]
  config file = /home/danclark/workspace/ansible/roles/openshift-equinix-coco/ansible.cfg
  configured module search path = ['/home/danclark/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3.11/site-packages/ansible
  ansible collection location = /home/danclark/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible
  python version = 3.11.8 (main, Feb  7 2024, 00:00:00) [GCC 13.2.1 20231011 (Red Hat 13.2.1-4)] (/usr/bin/python3)
  jinja version = 3.1.3
  libyaml = True
t0mk commented 3 months ago

@dmc5179 Thanks for reporting. I'll fix the docs.

ctreatma commented 3 months ago

This is related to #87 and we should take the opportunity to address that issue as part of updating the docs.