Feat: Updated Docs

[a1994sc]

This PR is to bring the docs into line with the recommended style from hashicorp, using their tool tfplugindocs

I tried to keep the docs feeling mostly the same well being within "spec", please let me know if any of the new docs are out of date. I mostly tried to keep what was still valid arguments and the descriptions for those arguments.

[Vad1mo]

@a1994sc thank you for your contribution. this is great.
Is there a need or option to automate things, with eg. gh action or is it a one time manual thing?

[a1994sc]

No problem to all! As for actions I am not too sure, that part is something that I have not dug to much into, but I did find this which seems to be a step in the right direction.

[a1994sc]

So I used the command tfplugindocs at the root of the repo to get all the files generated from the templates/*.tmpl files.

Edit: Sorry realized I removed the helm arg from the doc file and not the template.

[a1994sc]

@Vad1mo did you have any questions?

[OrlinVasilev]

that's great

[a1994sc]

Is the failing build, sonarcloud, something I should worry about?

[flbla]

Hi,
@a1994sc, thank you! It looks great!
I agree with @Vad1mo, It would be even better if we could implement a gh action
I'm concerned that I might forget to update the template and launch the CLI every time an update is made to the documentation.

[flbla]

maybe a gh action executed on pull request

[a1994sc]

@flbla so taking a look at what hashicorp does it seem they regenerate the docs: link , make

So I can add a similar action if you would like.

[flbla]

it seems good!
let me know if you need help
thank you!

[a1994sc]

@flbla Added a new action and it works locally can you let me know what you think?

[a1994sc]

I also only added the make setting for generating the docs, idk enough on the setup of this project, and golang in general, to do that lol

[a1994sc]

@Vad1mo I will try to debug why that action is failing... Thanks for the approval!

[flbla]

LGTM

[flbla]

@a1994sc : thank you 👍

[a1994sc]

@flbla No problem! Glad to contribute!