Skip to content

Add Developer guide and Architecture document#189

Merged
andrewhughes101 merged 1 commit into
mainfrom
skills-share
Dec 24, 2025
Merged

Add Developer guide and Architecture document#189
andrewhughes101 merged 1 commit into
mainfrom
skills-share

Conversation

@andrewhughes101

Copy link
Copy Markdown
Collaborator

Adds new developer guide with commands and reference for how to develop this collection
Adds a new Architecture document explaining how this collection is organised and works

@AndrewTwydell AndrewTwydell left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep looks great, couple related questions nice looking fine 👍🏼

Comment thread Architecture.md Outdated
Comment thread Architecture.md Outdated
Comment thread Architecture.md
Comment thread DEVELOPER_GUIDE.md Outdated
Comment thread DEVELOPER_GUIDE.md Outdated
Comment thread Architecture.md
- [`cmci.py`](plugins/module_utils/cmci.py) - Base class for all CMCI modules
- Handles HTTP communication with CMCI REST API
- Manages authentication (basic and certificate)
- Parses XML responses using xmltodict

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think xmltodict has been removed now so we can remove this or update it to mention using Python libs

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thats in this PR, not merged yet #190
It also has the change to remove this line

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah I see, I did a quick check in the code base and thought it had been removed already!

Comment thread DEVELOPER_GUIDE.md Outdated
**VS Code Extensions:**
- Red Hat Ansible extension
- Python extension
- GitLens for Git integration

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be removed?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh good find, so its also still in the devcontainer json, hence why its here, I'll remove it from both

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed and re-pushed

@Tom-Latham Tom-Latham left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@andrewhughes101 andrewhughes101 merged commit 99ab69d into main Dec 24, 2025
4 checks passed
@andrewhughes101 andrewhughes101 deleted the skills-share branch December 24, 2025 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants