Merge branch 'readme-no-inputs-doc' into 'main'

Refer to catalog input docs from README

See merge request components/opentofu!111

.gitlab/README.md.template

@@ -165,9 +165,11 @@ Have a look at the individual template spec to learn about the available inputs.
 
 ### Inputs
 
-| Name | Default | Description |
-| ---- | ------- | ----------- |
-<INPUTS>
+Please checkout the individual templates for the input definitions.
+The [catalog page](https://gitlab.com/explore/catalog/components/opentofu)
+beautifully renders the inputs for each templates - check it out!
+
+<RENDER>
 
 ### Variables
 

Makefile

@@ -2,11 +2,10 @@ all: docs
 
 .PHONY: docs
 docs:
-	csplit -sf readme -n 1 .gitlab/README.md.template '/<INPUTS>/'
+	csplit -sf readme -n 1 .gitlab/README.md.template '/<RENDER>/'
 	echo '<!-- This document is generated by `make docs` from `.gitlab/README.md` -->' > README.md
 	echo >> README.md
 	cat readme0 >> README.md
-	yq '.spec.inputs | .[] | "| `" + key + "` | `" + .default + "` | " + .description + (.options | (" Must be one of " + (. | filter((. | test("\$$.*")) == false) | map("`" + . + "`") | join(", ") + "." )) // "") + " |"' templates/full-pipeline.yml >> README.md
 	echo >> README.md
 	echo '### Available OpenTofu Versions' >> README.md
 	echo >> README.md

README.md

@@ -167,22 +167,10 @@ Have a look at the individual template spec to learn about the available inputs.
 
 ### Inputs
 
-| Name | Default | Description |
-| ---- | ------- | ----------- |
-| `stage_validate` | `validate` | Defines the validate stage. This stage includes the `fmt` and `validate` jobs. |
-| `stage_test` | `test` | Defines the test stage. This stage includes the `test` job. |
-| `stage_build` | `build` | Defines the build stage. This stage includes the `plan` job. |
-| `stage_deploy` | `deploy` | Defines the deploy stage. This stage includes the `apply` job. |
-| `stage_cleanup` | `cleanup` | Defines the cleanup stage. This stage includes the `destroy` and `delete-state` jobs. |
-| `version` | `latest` | Version of this component. Has to be the same as the one in the component include entry. |
-| `opentofu_version` | `1.7.2` | OpenTofu version that should be used. Must be one of `1.7.2`, `1.7.1`, `1.7.0`, `1.7.0-alpha1`, `1.6.2`, `1.6.1`, `1.6.0`. |
-| `image_registry_base` | `$CI_TEMPLATE_REGISTRY_HOST/components/opentofu` | Host URI to the job images. Will be combined with `image_name` to construct the actual image URI. |
-| `image_name` | `gitlab-opentofu` | Image name for the job images. Hosted under `image_registry_base`. |
-| `root_dir` | `${CI_PROJECT_DIR}` | Root directory for the OpenTofu project. |
-| `state_name` | `default` | Remote OpenTofu state name. |
-| `auto_apply` | `false` | Whether the apply job is manual or automatically run. |
-| `auto_destroy` | `false` | Whether the destroy job is manual or automatically run. |
-| `plan_artifacts_access` | `none` | Access level for the plan artifact. See https://docs.gitlab.com/ee/ci/yaml/#artifactsaccess for possible values. |
+Please checkout the individual templates for the input definitions.
+The [catalog page](https://gitlab.com/explore/catalog/components/opentofu)
+beautifully renders the inputs for each templates - check it out!
+
 
 ### Available OpenTofu Versions