add commands explanation

[AgnesNM]

Hello, I was wondering whether adding a little 'breakdown' of the commands on the official Helm Chart docs might help?

Especially for people who are completely new to the tool?

As in:

Installing the Chart

helm repo add apache-airflow https://airflow.apache.org helm upgrade --install airflow apache-airflow/airflow --namespace airflow --create-namespace

Explanation:
helm repo add apache-airflow https://airflow.apache.org

• helm repo add is a command to add a chart repository

helm upgrade --install airflow apache-airflow/airflow --namespace airflow --create-namespace

Explanation

• helm upgrade is a command to upgrade a release
• the first 'airflow' argument is the release name
• 'apache-airflow/airflow' is the Helm Chart
• the second 'airflow' argument is the namespace

Upgrading the Chart

helm upgrade airflow apache-airflow/airflow --namespace airflow

• helm upgrade is a command to upgrade a release
• the first 'airflow' argument is the release name
• 'apache-airflow/airflow' is the Helm Chart
• the second 'airflow' argument is the namespace

Uninstalling the Chart

helm delete airflow --namespace airflow

Explanation

• helm delete is a command to delete a release (it has now been renamed to helm uninstall)
• the first 'airflow' argument is the release name
• the second 'airflow' argument is the namespace

[boring-cyborg]

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

• Pay attention to the quality of your code (flake8, mypy and type annotations). Our pre-commits will help you with that.
• In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
• Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
• Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
• Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
• Be sure to read the Airflow Coding style.
  Apache Airflow is a community-driven project and together we are making it better 🚀.
  In case of doubts contact the developers at:
  Mailing List: dev@airflow.apache.org
  Slack: https://s.apache.org/airflow-slack

[dstandish]

Hey @AgnesNM thanks for your contribution.

I think it might be better rework the existing instructions for clarity rather than adding an explanation block.

So for example, replace this:

To install this chart using Helm 3, run the following commands:
.. code-block:: bash
    helm repo add apache-airflow https://airflow.apache.org
    helm upgrade --install airflow apache-airflow/airflow --namespace airflow --create-namespace

With

To install this chart using Helm 3, first add the helm chart repository:

.. code-block:: bash
    helm repo add apache-airflow https://airflow.apache.org

Next, install the helm chart:

.. code-block:: bash
    helm upgrade --install airflow apache-airflow/airflow --namespace airflow --create-namespace

That way, we get the description saying what these commands actually do. Better continuity compared with explaining in a diff section.

[dstandish]

similar to above, i would suggest that you amend existing wording if not clear already rather than adding an explanation section.

I would not document the argument syntax --- that's not our role in airflow, that is the job of the helm docs.

[dstandish]

instead, can you amend existing to replace delete with uninstall?

also, rather than explaining this

- the first 'airflow' argument is the release name
- the second 'airflow' argument is the namespace

maybe better would be to choose better names in the example in the first place... so instead of airflow (namespace) choose my-namespace, and instead of airflow (release) maybe choose my-release-name or my-airflow-release.... WDYT?

[blag]

I like this idea. It helps break up the Helm commands to identify different things with different names, instead of leaving that implicit. I would try to identify things with their types, so something like my-airflow-namespace, even though that looks a little wordy, it's more helpful for people who aren't familiar with it.

[blag]

Another thing that might help is using (making up a term here) the "options assignment" syntax, if Helm supports it:

helm repo add apache-airflow https://airflow.apache.org
helm upgrade --install=airflow apache-airflow/airflow --create-namespace --namespace=airflow
helm upgrade airflow apache-airflow/airflow --namespace=airflow
helm delete airflow --namespace=airflow

But if it doesn't then feel free to disregard.

[dstandish]

Yeah that's a good idea @blag but unfortunately I don't think that the helm command allows that... it's just positional

I think I found this confusing at one point in the past also

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 5 days if no further activity occurs. Thank you for your contributions.