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

[DOCS] add example of environment variable substitution #10417

Merged
merged 20 commits into from
Oct 2, 2024

Conversation

adeola-ak
Copy link
Contributor

@adeola-ak adeola-ak commented Sep 18, 2024

doc update that adds a Data Source credential management section and walks the user through how to use environment variable substitution

walks the user through how to use environment variable substitution
@gx-cla-bot
Copy link

gx-cla-bot bot commented Sep 18, 2024

A new contributor, HUZZAH! Welcome and thanks for joining our community. In order to accept a pull request we require that all contributors sign our Contributor License Agreement. We have two different CLAs, depending on whether you are contributing to GX in a personal or professional capacity. Please sign the one that is applicable to your situation so that we may accept your contribution:

Individual Contributor License Agreement v1.0
Software Grant and Corporate Contributor License Agreement v1.0

Once you have signed the CLA, you can add a comment with the text @cla-bot check and the bot will update the PR status!

Please reach out to the #gx-community-support channel, on our Slack if you have any questions or if you have already signed the CLA and are receiving this message in error.

Users missing a CLA: adeola-ak

@adeola-ak adeola-ak requested a review from rachhouse September 18, 2024 00:25
Copy link

netlify bot commented Sep 18, 2024

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit d8a720a
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/66fc8131305a300009216715
😎 Deploy Preview https://deploy-preview-10417.docs.greatexpectations.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Sep 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.96%. Comparing base (69709c0) to head (d8a720a).
Report is 1 commits behind head on develop.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #10417      +/-   ##
===========================================
- Coverage    79.97%   79.96%   -0.01%     
===========================================
  Files          461      461              
  Lines        40000    40000              
===========================================
- Hits         31988    31987       -1     
- Misses        8012     8013       +1     
Flag Coverage Δ
3.10 67.57% <ø> (ø)
3.10 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds ?
3.10 aws_deps ?
3.10 big ?
3.10 filesystem ?
3.10 mssql ?
3.10 mysql ?
3.10 postgresql ?
3.10 spark_connect ?
3.10 trino ?
3.11 67.59% <ø> (+0.01%) ⬆️
3.11 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds ?
3.11 aws_deps ?
3.11 big ?
3.11 filesystem ?
3.11 mssql ?
3.11 mysql ?
3.11 postgresql ?
3.11 spark_connect ?
3.11 trino ?
3.12 66.19% <ø> (-0.02%) ⬇️
3.12 aws_deps 45.90% <ø> (ø)
3.12 big 54.52% <ø> (ø)
3.12 filesystem 61.30% <ø> (ø)
3.12 mssql 49.99% <ø> (ø)
3.12 mysql 50.05% <ø> (ø)
3.12 postgresql 54.31% <ø> (ø)
3.12 spark 57.82% <ø> (ø)
3.12 spark_connect 46.19% <ø> (ø)
3.12 trino 52.44% <ø> (ø)
3.8 67.61% <ø> (-0.02%) ⬇️
3.8 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds 55.11% <ø> (ø)
3.8 aws_deps 45.92% <ø> (ø)
3.8 big 54.54% <ø> (ø)
3.8 databricks 47.63% <ø> (ø)
3.8 filesystem 61.32% <ø> (ø)
3.8 mssql 49.97% <ø> (ø)
3.8 mysql 50.04% <ø> (ø)
3.8 postgresql 54.30% <ø> (ø)
3.8 snowflake 48.48% <ø> (ø)
3.8 spark 57.79% <ø> (ø)
3.8 spark_connect 46.21% <ø> (ø)
3.8 trino 52.43% <ø> (ø)
3.9 67.60% <ø> (-0.02%) ⬇️
3.9 athena or clickhouse or openpyxl or pyarrow or project or sqlite or aws_creds ?
3.9 aws_deps ?
3.9 big ?
3.9 filesystem ?
3.9 mssql ?
3.9 mysql ?
3.9 postgresql ?
3.9 spark_connect ?
3.9 trino ?
cloud 0.00% <ø> (ø)
docs-basic 52.51% <ø> (ø)
docs-creds-needed 52.73% <ø> (ø)
docs-spark 52.13% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@gx-cla-bot
Copy link

gx-cla-bot bot commented Sep 18, 2024

A new contributor, HUZZAH! Welcome and thanks for joining our community. In order to accept a pull request we require that all contributors sign our Contributor License Agreement. We have two different CLAs, depending on whether you are contributing to GX in a personal or professional capacity. Please sign the one that is applicable to your situation so that we may accept your contribution:

Individual Contributor License Agreement v1.0
Software Grant and Corporate Contributor License Agreement v1.0

Once you have signed the CLA, you can add a comment with the text @cla-bot check and the bot will update the PR status!

Please reach out to the #gx-community-support channel, on our Slack if you have any questions or if you have already signed the CLA and are receiving this message in error.

Users missing a CLA: adeola-ak

@gx-cla-bot
Copy link

gx-cla-bot bot commented Sep 18, 2024

A new contributor, HUZZAH! Welcome and thanks for joining our community. In order to accept a pull request we require that all contributors sign our Contributor License Agreement. We have two different CLAs, depending on whether you are contributing to GX in a personal or professional capacity. Please sign the one that is applicable to your situation so that we may accept your contribution:

Individual Contributor License Agreement v1.0
Software Grant and Corporate Contributor License Agreement v1.0

Once you have signed the CLA, you can add a comment with the text @cla-bot check and the bot will update the PR status!

Please reach out to the #gx-community-support channel, on our Slack if you have any questions or if you have already signed the CLA and are receiving this message in error.

Users missing a CLA: adeola-ak

@gx-cla-bot
Copy link

gx-cla-bot bot commented Sep 18, 2024

A new contributor, HUZZAH! Welcome and thanks for joining our community. In order to accept a pull request we require that all contributors sign our Contributor License Agreement. We have two different CLAs, depending on whether you are contributing to GX in a personal or professional capacity. Please sign the one that is applicable to your situation so that we may accept your contribution:

Individual Contributor License Agreement v1.0
Software Grant and Corporate Contributor License Agreement v1.0

Once you have signed the CLA, you can add a comment with the text @cla-bot check and the bot will update the PR status!

Please reach out to the #gx-community-support channel, on our Slack if you have any questions or if you have already signed the CLA and are receiving this message in error.

Users missing a CLA: adeola-ak

@adeola-ak
Copy link
Contributor Author

@cla-bot check

@rachhouse
Copy link
Contributor

I'm going to merge in develop to retrigger the Netlify build so we can see the rendered page - I haven't seen it fail in initializing before, hopefully it was just a temporary issue?

adeola-ak and others added 7 commits September 19, 2024 11:09
Co-authored-by: Rachel House <[email protected]>
Co-authored-by: Rachel House <[email protected]>
Co-authored-by: Rachel House <[email protected]>
Co-authored-by: Rachel House <[email protected]>
Co-authored-by: Rachel House <[email protected]>
Co-authored-by: Rachel House <[email protected]>
@adeola-ak
Copy link
Contributor Author

@rachhouse looks like the build isn't failing now, thanks

Screenshot 2024-09-19 at 1 49 41 PM

I can't find where I can update the tabs where it says Secure Your Api Data Source Connection String to be Data Source credential management instead

@rachhouse
Copy link
Contributor

Hey @adeola-ak, you just need to update docs/docusarus/sidebars.js. Search for "Secure your GX API Data Source connection strings" in that file, and then you can update the label (which reflects the page title in the TOC) and the href so that it points to the new section.

@adeola-ak adeola-ak changed the title [docs] add example of environment variable substitution [DOCS] add example of environment variable substitution Sep 30, 2024
@adeola-ak adeola-ak requested a review from rachhouse October 1, 2024 14:50
Copy link
Contributor

@rachhouse rachhouse left a comment

Choose a reason for hiding this comment

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

Approved w/ comments (just a small text de-bolding change) so I don't hold you up on merging. Thanks!

docs/docusaurus/sidebars.js Outdated Show resolved Hide resolved
@adeola-ak adeola-ak added this pull request to the merge queue Oct 2, 2024
Merged via the queue into develop with commit d69df80 Oct 2, 2024
64 checks passed
@adeola-ak adeola-ak deleted the adeola-ak-docs-2 branch October 2, 2024 01:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants