summaryrefslogtreecommitdiffstats
path: root/ansible_collections/cisco/intersight/Development.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:03:42 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:03:42 +0000
commit66cec45960ce1d9c794e9399de15c138acb18aed (patch)
tree59cd19d69e9d56b7989b080da7c20ef1a3fe2a5a /ansible_collections/cisco/intersight/Development.md
parentInitial commit. (diff)
downloadansible-66cec45960ce1d9c794e9399de15c138acb18aed.tar.xz
ansible-66cec45960ce1d9c794e9399de15c138acb18aed.zip
Adding upstream version 7.3.0+dfsg.upstream/7.3.0+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/cisco/intersight/Development.md')
-rw-r--r--ansible_collections/cisco/intersight/Development.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/ansible_collections/cisco/intersight/Development.md b/ansible_collections/cisco/intersight/Development.md
new file mode 100644
index 00000000..6f79a1be
--- /dev/null
+++ b/ansible_collections/cisco/intersight/Development.md
@@ -0,0 +1,26 @@
+# cisco.intersight Collection Development Notes
+
+### Current Development Status
+
+| Configuration Category | Configuration Task | Module Name |
+| ---------------------- | ------------------ | ----------- |
+| General purpose resource config | Any (with user provided data) | intersight_rest_api |
+| Resource data collection/inventory | GET servers information | intersight_facts |
+
+### Ansible Development Notes
+
+Modules in development follow processes documented at http://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html. The modules support ansible-doc and should eventually have integration tests.
+
+When developing modules in this repository, here are a few helpful commands to sanity check the code and documentation (replace module_name with your module (e.g., intersight_objects)). Ansible modules won't generally be pylint or pycodestyle (PEP8) clean without disabling several of the checks:
+ ```
+ pylint --disable=invalid-name,no-member,too-many-nested-blocks,redefined-variable-type,too-many-statements,too-many-branches,broad-except,line-too-long,missing-docstring,wrong-import-position,too-many-locals,import-error <module_name>.py
+
+ pycodestyle --max-line-length 160 --config /dev/null --ignore E402 <module_name>.py
+
+ ansible-doc <module_name>
+ ```
+
+# Community:
+
+* We are on Slack (https://ciscoucs.slack.com/) - Slack requires registration, but the ucspython team is open invitation to
+ anyone. Click [here](https://ucspython.herokuapp.com) to register