Add feature/plugin development guide

[arvind4501]

Documents the complete workflow for adding features to foremanctl, covering feature registration, Smart Proxy configuration, deployment, and validation.

Note:- Generated with help of claude

[ehelms]

What do you think about putting this info in DEVELOPMENT.md for now?

I do think we have started to reach a point where we need to have two sets of docs: user-facing and developer-facing. And that we will need to split them. For example, docs/user docs/developer. I think this can help human discover ability and reading and AI.

[arvind4501]

I have splitted our docs into docs/user and docs/developer and added respective docs into those.
I only find certificates.md and parameters.md good condidate user facing docs.

[arvind4501]

What do you think about putting this info in DEVELOPMENT.md for now?

IMHO we could add it to DEVELOPMENT.md but that would be a lot of content in a single doc(and its only going to increase by time), and i prefer how we do it in our foreman core https://github.com/theforeman/foreman/tree/develop/developer_docs , specific doc for a thing makes it better to navigate.

[ehelms]

I would consider these user facing:

• https://github.com/theforeman/foremanctl/blob/master/docs/certificates.md
• https://github.com/theforeman/foremanctl/blob/master/docs/deployment.md
• https://github.com/theforeman/foremanctl/blob/master/docs/parameters.md

You could argue that there are elements of both user and development in these. And then the question of is it better to split them based on that or to keep both together.

What do you think?

[arvind4501]

TBH, i think as most of the docs are useful for both user and developer, its hard to distinguish. I think we can leave all docs in docs/ (or dev_docs as we do in foreman core repo) and it can be consumed by users(mostly satellite admins) and developers both. and then we can update Readme to have all needed info to get started with foremanctl.

I would also love to hear from @ekohl on this.

[arvind4501]

after theforeman/foreman-packaging#13163 obsah works for ansible 2.16 which is present in foreman-plugins repo

[ehelms]

Is it worth documenting this here? Obsah requires Ansible, and either it will install whatever version or the RPM will. I don't see anything in this repository enforcing this Ansible version.

[arvind4501]

Yes, foremanctl does not directly deal with ansible-core, obsah uses it. I remember @ianballou faced some issues related to python3.12dist(ansible-core) not available in RHEL 9 repos and it is required by foremanctl/obsah. thus i ended up documenting it here

[jafiala]

Just some clarity suggestions

[evgeni]

I'd prefer to avoid having dedicated contributing docs in each repo. This PR should focus on the plugin dev flow, nothing else.

[arvind4501]

i can remove contributing docs,sure, but i expect the readme, other doc changes to go in with this dev doc improvement

[stejskalleos]

🍏 I'm fine with merging it as it is, doing continuous updates as we progress in development.