-
Story
-
Resolution: Done
-
Undefined
-
None
-
None
-
None
-
False
-
-
False
-
-
It may be confusing for users to have 2 files that get them ready to use the workflow, hence
the README and INSTALL files for workflows we maintained shall be merge as 1 file.
Take on the opportunity to list, for each workflow in their README, the properties that needs to be configured and/or the associated env var (like it's done for the values.yaml for the helm chart)
- https://github.com/parodos-dev/serverless-workflows/blob/main/**/README.md is focus on DEV
- https://github.com/parodos-dev/serverless-workflows-config/blob/gh-pages/docs/**/ is PROD
- https://github.com/parodos-dev/serverless-workflows-config/blob/main/charts/**/INSTALL.md/README.md should point to the PROD doc (https://github.com/parodos-dev/serverless-workflows-config/blob/gh-pages/docs/**/) => the files must be merged and moved to https://github.com/parodos-dev/serverless-workflows-config/blob/gh-pages/docs/**/README.me then the README.md shall contains a single link to the PROD doc
- relates to
-
FLPATH-1713 [docs] Troubleshooting docs needs fixing
-
- Closed
-
- links to