search

parodos-dev / orchestrator-helm-chart

Helm chart to deploy the Orchestrator solution suite.
https://parodos.dev/orchestrator-helm-chart/
Apache License 2.0
2 stars 22 forks source link

Improve installation steps #130

Closed gciavarrini closed 5 months ago

gciavarrini commented 5 months ago

IMO the distinction b/w Quick and Detailed set of instructions can generate some confusion. If we consider the different options for each of these instructions, we are describing ~10 different command lines, some of which are identical (e.g. the Quick/Option 1 is the same as the Detailed/Install the chart with Orchestrator plugin and Notifications plugin, and probably also Quick/Option 2 is duplicated). Also, some instructions for the external tools (pSql, RHO Gitops and RHO Pipelines) are defined in a different way in the 2 sections, if I read it properly.

I think the document could be simplified a bit by describing the orchestrator.devmode only once instead of repeating it many times and specifying the meaning of the required env variables in a dedicated section, where we can introduce the setenv.sh tool as a provided command to populate them from a live environment.

@dmartinol Is it better?

dmartinol commented 5 months ago

IMO the distinction b/w Quick and Detailed set of instructions can generate some confusion. If we consider the different options for each of these instructions, we are describing ~10 different command lines, some of which are identical (e.g. the Quick/Option 1 is the same as the Detailed/Install the chart with Orchestrator plugin and Notifications plugin, and probably also Quick/Option 2 is duplicated). Also, some instructions for the external tools (pSql, RHO Gitops and RHO Pipelines) are defined in a different way in the 2 sections, if I read it properly. I think the document could be simplified a bit by describing the orchestrator.devmode only once instead of repeating it many times and specifying the meaning of the required env variables in a dedicated section, where we can introduce the setenv.sh tool as a provided command to populate them from a live environment.

@dmartinol Is it better?

I think there are still some duplicate instructions (if I can read them correctly), but I'll leave the final word to the QE engineer, as I imagine he's also validating this as he comments.

masayag commented 5 months ago

@gciavarrini apologizing for noticing this before, I was under the assumption this document reside in the gh-pages branch.

To avoid duplicating the document, pls split this into the script to be added to the main branch and document changes to be done on the gh-pages. This will render the changes to parodos.dev site and to the charts site. This will also reduce the need to maintain two copies.

If you prefer to merge this first and move later, I'm okay with this approach as well.