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

chore(docs): remove mention of MariaDB in dev environment setup #29790

Merged
merged 2 commits into from
Jul 31, 2024

Conversation

sfirke
Copy link
Member

@sfirke sfirke commented Jul 31, 2024

MariaDB is not a supported backend for Superset, so it is misleading to suggest it for a development environment. The commit that named MariaDB here is quite old -- I traced it back to a docs overall from 3 years ago, it is likely older than that (the PR was upgrading the docs system) but I stopped there.

There are two other things that could be addressed here:

  • Does, in fact, a DB need to be installed at this step? I didn't see it referenced immediately. If no, remove this whole sentence. If yes, provide an example command.
  • Would Postgres be an acceptable alternative? If so, say that.

If someone knows the answer please feel free to suggest the complete fix. But if no one knows, removing the MariaDB mention is an adequate improvement for now.

@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Jul 31, 2024
@dosubot dosubot bot added the doc:developer Developer documentation label Jul 31, 2024
@rusackas
Copy link
Member

Oops... my little documentation link checker is finding issues. I'll push a commit here to (hopefully) resolve that.

@github-actions github-actions bot added the github_actions Pull requests that update GitHub Actions code label Jul 31, 2024
@rusackas rusackas changed the title choredocs): remove mention of MariaDB in dev environment setup chore(docs): remove mention of MariaDB in dev environment setup Jul 31, 2024
@rusackas rusackas merged commit 714caea into master Jul 31, 2024
36 of 38 checks passed
@rusackas rusackas deleted the dev-environment-redact-mariadb branch July 31, 2024 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc:developer Developer documentation doc Namespace | Anything related to documentation github_actions Pull requests that update GitHub Actions code size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants