Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix ref anchor for env var link in Connection how-to doc #29816

Merged
merged 1 commit into from
Mar 2, 2023

Conversation

josh-fell
Copy link
Contributor

In the "Managing Connections" how-to doc, the "environment variables" links in the doc point to the "Security of connections in the database" section rather than the "Storing connections in environment variables" section.

@@ -102,5 +102,5 @@ For example, to add a connection with the connection ID of "dbt_cloud_default":
export AIRFLOW_CONN_DBT_CLOUD_DEFAULT='dbt-cloud://:api_token@my-tenant.getdbt.com'

You can refer to the documentation on
:ref:`creating connections via environment variables <environment_variables_secrets_backend>` for more
:ref:`creating connections via environment variables <environment_variables_connections>` for more
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same reference anchor was used in the dbt Cloud connection docs too.

@josh-fell josh-fell changed the title Move ref anchor for env var link in Connection how-to doc Update ref anchor for env var link in Connection how-to doc Feb 28, 2023
@josh-fell josh-fell changed the title Update ref anchor for env var link in Connection how-to doc Fix ref anchor for env var link in Connection how-to doc Mar 1, 2023
In the "Managing Connections" how-to doc, the "environment variables" links in the doc point to the "Security of connections in the database" section rather than the "Storing connections in environment variables" section.
@eladkal eladkal added this to the Airflow 2.5.2 milestone Mar 2, 2023
@eladkal eladkal added the type:doc-only Changelog: Doc Only label Mar 2, 2023
@josh-fell
Copy link
Contributor Author

josh-fell commented Mar 2, 2023

@eladkal Should we hold off on the merging this for now since the dbt Cloud connection doc is involved here and the next provider wave is in progress? Or it's fine and the dbt Cloud change will just be part of the next wave?

@eladkal
Copy link
Contributor

eladkal commented Mar 2, 2023

We can merge but I guess since releases are not synced there will be some time that the reference won't work

@eladkal
Copy link
Contributor

eladkal commented Mar 2, 2023

Also, probably we should start look into the cross references of providers -> core. Ideally providers docs should be stand alone. They should not use internal references because we want to treat providers as stand alone packages.

@josh-fell
Copy link
Contributor Author

We can merge but I guess since releases are not synced there will be some time that the reference won't work

I think that's fine. It's the only provider that uses this link and there are a few examples of creating the connection with env vars too.

@josh-fell josh-fell merged commit b33b11b into apache:main Mar 2, 2023
@josh-fell josh-fell deleted the howto-conn-doc branch March 2, 2023 18:05
pierrejeambrun pushed a commit that referenced this pull request Mar 7, 2023
In the "Managing Connections" how-to doc, the "environment variables" links in the doc point to the "Security of connections in the database" section rather than the "Storing connections in environment variables" section.

(cherry picked from commit b33b11b)
pierrejeambrun pushed a commit that referenced this pull request Mar 8, 2023
In the "Managing Connections" how-to doc, the "environment variables" links in the doc point to the "Security of connections in the database" section rather than the "Storing connections in environment variables" section.

(cherry picked from commit b33b11b)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants