Generate provider docs #229
Conversation
onematchfox
force-pushed
the
docs/generate
branch
3 times, most recently
from
64b75a4 to
2148f94
Compare
|
@oboukili, this one is now ready for your eyes. Just so you know, in case you had already scanned some of it, the scope did grow a bit from when I first opened it as I decided to do some cleaning up in the Makefile and GitHub actions while I was integrating the docs generation there. |
onematchfox
force-pushed
the
docs/generate
branch
2 times, most recently
from
1e1899b to
04d2ddc
Compare
|
This pr is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 10 days. |
|
This pr is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 10 days. |
|
@oboukili when you get the chance, please can you take a look at this? |
|
This pr is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 10 days. |
|
@oboukili still waiting on you for this one please |
Related: - argoproj-labs#126 - hashicorp/terraform-plugin-docs#66 (Nested Schema for `info` for `argocd_cluster`)
Also bumps version of existing steps
Resolves following warning: ``` Node.js 12 actions are deprecated. Please update the following actions to use Node.js 16: actions/checkout@v2. For more information see: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/. ```
Also adds project logos
onematchfox
force-pushed
the
docs/generate
branch
from
04d2ddc to
dddd933
Compare
|
@MrLuje any chance you might be able to review these changes? |
Sure, I'll have a look |
|
Thanks for the review @MrLuje. Much appreciated! |
I realised when reviewing #224 that some of the provider docs are a bit outdated these days, as the updates occasionally get missed when reviewing PRs. This PR attempts to help address the issue by introducing the use of tfplugindocs (as recommended in #224) to generate provider documentation ensuring that it is easier to keep this in sync ().
I have also used the opportunity to:
README.mdslightly whilst also explicitly calling out the provider's use case of managing ArgoCD resources (not bootstrapping/install ArgoCD). This has come up in the past (see Bit more documentation about intended use of the provider #126), and whilst there is/never was any confusion in my head around the provider's purpose, I suspect that others may get confused given that the Flux terraform providerNotes:
tfplugindocsis not perfect, which does result in some loss of documentation for computed fields due to bug: attribute descriptions are not rendered in read-only nested block hashicorp/terraform-plugin-docs#66. This affects clusterinfo.schema.TypeSetfor applicationsync_policy#228, so will leave it in draft until that has been reviewed.