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.

Sign up for GitHub

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

Jump to bottom

docs: improve documentation(docs): clarify URL encoding requirement for connection strings #30047

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: improve documentation(docs): clarify URL encoding requirement for connection strings #30047

wants to merge 1 commit into from

Conversation

kalai-logicsoft
Copy link

@kalai-logicsoft kalai-logicsoft commented Aug 29, 2024 •
edited
Loading

SUMMARY

Enhance the documentation of the connection string used in the backend of Superset by adding additional information for improved understanding.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

State Image
Before msedge_y1qctZf1yH
After image

TESTING INSTRUCTIONS

  1. Start the documentation site following these instructions.
  2. Navigate to the SQL Server section on Connecting to Databases page (/docs/configuration/databases#sql-server).
  3. Verify that the additional notes information is present and accurate.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

See more discussions on this issue #29979

@kalai-logicsoft
docs: clarify URL encoding requirement for connection strings
d4b6b25 
Adding extra information for the better understanding of connection string which is used for the backend of Superset. Based on this [Issue](apache#29979) People are finding difficulties in understanding the connection string, The `SQLAlchemy` documentation clearly talks about this URL encoded connection string, but users of superset not required to read / understand the concept of `SQLAlchemy` so adding this extra information may help them.
@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Aug 29, 2024
github-actions[bot]
github-actions bot reviewed Aug 29, 2024
View reviewed changes
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Congrats on making your first PR and thank you for contributing to Superset! 🎉 ❤️

We hope to see you in our Slack community too! Not signed up? Use our Slack App to self-register.

@kalai-logicsoft kalai-logicsoft mentioned this pull request Aug 29, 2024
Open
@michael-s-molina michael-s-molina changed the title improve documentation(docs): clarify URL encoding requirement for connection strings docs: improve documentation(docs): clarify URL encoding requirement for connection strings Aug 29, 2024
@michael-s-molina michael-s-molina added the review:checkpoint Last PR reviewed during the daily review standup label Aug 29, 2024
@sfirke
Copy link
Member

sfirke commented Sep 3, 2024

Thanks for the pull request! You wrote:

See more discussions on this issue #30045
But that issue looks unrelated. Could you have meant to link a separate issue?

Is this addition specific to SQL Server only or should it be added to this page in general?

@michael-s-molina michael-s-molina removed the review:checkpoint Last PR reviewed during the daily review standup label Sep 3, 2024
@kalai-logicsoft
Copy link
Author

kalai-logicsoft commented Sep 4, 2024 •
edited
Loading

Is this addition specific to SQL Server only or should it be added to this page in general?

Thanks for your appreciation,

From the SQLAlchemy documentation I understood that it applies to all database connection strings which used via SQLAlchemy to connect. So, it will apply to page level.

And one more information related to this is already the documentation for AWS Athena has information related to this but specific to Athena database.

@kalai-logicsoft
Copy link
Author

But that issue looks unrelated. Could you have meant to link a separate issue?

I had provided the wrong link earlier. I’ve now updated it with the correct issue discussion. I apologize for any confusion caused.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions GitHub Actions GitHub Actions left review comments

@rusackas rusackas Awaiting requested review from rusackas

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
doc Namespace | Anything related to documentation size/XS
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kalai-logicsoft @sfirke @michael-s-molina