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] In-app agent request #10836

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open

Conversation

klavavej
Copy link
Contributor

@klavavej klavavej commented Jan 9, 2025

Resolves https://greatexpectations.atlassian.net/browse/DOC-1019 according to the plan linked in that issue

  • Description of PR changes above includes a link to an existing GitHub issue
  • PR title is prefixed with one of: [BUGFIX], [FEATURE], [DOCS], [MAINTENANCE], [CONTRIB]
  • Code is linted - run invoke lint (uses ruff format + ruff check)
  • Appropriate tests and docs have been updated

Deploy Preview at https://deploy-preview-10836.docs.greatexpectations.io/docs/cloud/deploy/deploy_gx_agent

@netlify /docs/cloud/deploy/deploy_gx_agent

For more information about contributing, visit our community resources.

After you submit your PR, keep the page open and monitor the statuses of the various checks made by our continuous integration process at the bottom of the page. Please fix any issues that come up and reach out on Slack if you need help. Thanks for contributing!

Copy link

netlify bot commented Jan 9, 2025

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit e0d55ed
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/67856368a901d60008a0e48b
😎 Deploy Preview https://deploy-preview-10836.docs.greatexpectations.io/docs/cloud/deploy/deploy_gx_agent
📱 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.

@@ -1,7 +1,7 @@
---
title: 'Deploy the GX Agent'
id: deploy_gx_agent
description: Deploy the GX Agent to use GX Cloud features and functionality.
description: Deploy the GX Agent to test locally or enhance security.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note for reviewers: Though not in the plan, I updated the page description because it looked outdated to me. Apologies for scope creep


Use the information provided here to view your organization ID or create a new access token. This can be helpful if you've forgotten your organization ID or access token, and you need to restart the GX Agent.
Copy link
Contributor Author

@klavavej klavavej Jan 9, 2025

Choose a reason for hiding this comment

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

note for reviewers: though not in the plan, I decided to remove this text because it doesn't make as much sense with the tabs in this section removed.


If you've used GX Cloud previously, you have your access token and organization ID, and you need to restart the GX Agent, see [Deploy the GX Agent](#deploy-the-gx-agent).
Copy link
Contributor Author

@klavavej klavavej Jan 9, 2025

Choose a reason for hiding this comment

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

note for reviewers: though not in the plan, I decided to remove this since this callout makes less sense with the "New GX Cloud account" tab removed. Also it should be intuitive for folks who already have their access token and org id to skip over this section based on the section header alone.

@klavavej klavavej marked this pull request as ready for review January 9, 2025 18:31
Copy link

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.39%. Comparing base (3a2ad9b) to head (e0d55ed).

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #10836      +/-   ##
===========================================
- Coverage    80.69%   80.39%   -0.30%     
===========================================
  Files          465      465              
  Lines        40493    40493              
===========================================
- Hits         32676    32555     -121     
- Misses        7817     7938     +121     
Flag Coverage Δ
3.10 69.99% <ø> (ø)
3.10 athena or openpyxl or pyarrow or project or sqlite or aws_creds ?
3.10 aws_deps ?
3.10 big ?
3.10 clickhouse ?
3.10 filesystem ?
3.10 mssql ?
3.10 mysql ?
3.10 postgresql ?
3.10 spark_connect ?
3.10 trino ?
3.11 69.99% <ø> (-0.02%) ⬇️
3.11 athena or openpyxl or pyarrow or project or sqlite or aws_creds ?
3.11 aws_deps ?
3.11 big ?
3.11 clickhouse ?
3.11 filesystem ?
3.11 mssql ?
3.11 mysql ?
3.11 postgresql ?
3.11 spark_connect ?
3.11 trino ?
3.12 70.00% <ø> (ø)
3.12 athena or openpyxl or pyarrow or project or sqlite or aws_creds 56.40% <ø> (ø)
3.12 aws_deps 46.24% <ø> (ø)
3.12 big 54.75% <ø> (ø)
3.12 bigquery 48.52% <ø> (ø)
3.12 databricks 50.29% <ø> (ø)
3.12 filesystem 62.74% <ø> (ø)
3.12 mssql 51.29% <ø> (ø)
3.12 mysql 51.70% <ø> (ø)
3.12 postgresql 54.34% <ø> (ø)
3.12 snowflake 51.11% <ø> (ø)
3.12 spark 57.68% <ø> (ø)
3.12 spark_connect 46.53% <ø> (ø)
3.12 trino 52.25% <ø> (ø)
3.9 70.03% <ø> (+0.01%) ⬆️
3.9 athena or openpyxl or pyarrow or project or sqlite or aws_creds 56.40% <ø> (ø)
3.9 aws_deps 46.26% <ø> (ø)
3.9 big 54.76% <ø> (ø)
3.9 bigquery 48.52% <ø> (ø)
3.9 clickhouse 43.15% <ø> (ø)
3.9 databricks 50.29% <ø> (ø)
3.9 filesystem 62.74% <ø> (ø)
3.9 mssql 51.27% <ø> (ø)
3.9 mysql 51.68% <ø> (ø)
3.9 postgresql 54.33% <ø> (ø)
3.9 snowflake 51.11% <ø> (ø)
3.9 spark 57.64% <ø> (ø)
3.9 spark_connect 46.54% <ø> (ø)
3.9 trino 52.23% <ø> (ø)
cloud 0.00% <ø> (ø)
docs-basic 53.90% <ø> (ø)
docs-creds-needed ?
docs-spark 52.34% <ø> (ø)

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.

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