[GitHub] [airflow] mik-laj commented on a change in pull request #5973: [AIRFLOW-XXX] Use full command in examples

[GitBox <gi...@apache.org>]

mik-laj commented on a change in pull request #5973: [AIRFLOW-XXX] Use full command in examples
URL: https://github.com/apache/airflow/pull/5973#discussion_r319934665
 
 

 ##########
 File path: docs/howto/connection/ssh.rst
 ##########
 @@ -66,4 +66,4 @@ Extra (optional)
 
     .. code-block:: bash
 
-        ssh://user:pass@localhost:22?timeout=10&compress=false&no_host_key_check=false&allow_host_key_change=true&key_file=%2Fhome%2Fairflow%2F.ssh%2Fid_rsa
+        export AIRFLOW_CONN_MAIN_SERVER='ssh://user:pass@localhost:22?timeout=10&compress=false&no_host_key_check=false&allow_host_key_change=true&key_file=%2Fhome%2Fairflow%2F.ssh%2Fid_rsa'
 
 Review comment:
   This is an example of how to set up any connection, not just the default connection. Configuration from variables is read every time you try to get the connection. The purpose of this PR is to improve the examples to show the code more close to real use, but not necessarily to configure the default connection. I think that this change is also helpful in this case, because it allows you to understand how to set the connection using environment variables. I often configure the connection using variable environments and I would like to be able to look only at one place for documentation and have a ready example. 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services