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: depricated Marking on outdated docs - Local dev setup superset #28207

Closed
wants to merge 4 commits into from

Conversation

surapuramakhil
Copy link

@surapuramakhil surapuramakhil commented Apr 25, 2024

SUMMARY

I have spent multiple hours in figuring out setting up my local superset (development) setup.

I have followed both docs https://github.com/apache/superset/blob/master/CONTRIBUTING.md
and https://github.com/apache/superset/blob/master/docs/docs/contributing/local-backend.mdx

Ended up with a bunch of errors. (tried fixing, but chain it continuing) lot of breaking stuff.

I have even tried PyPI installation methods (even that method breaks) while delivering frontend content. Marked deprecated

Current way is https://superset.apache.org/docs/installation/docker-compose#option-1---for-an-interactive-development-environment

Updated same in other places.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

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

@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Apr 25, 2024
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.

@mistercrunch mistercrunch changed the title Depricated Marking on outdated docs - Local dev setup superset docs: depricated Marking on outdated docs - Local dev setup superset Apr 25, 2024
@rusackas
Copy link
Member

While docker-compose is probably easiest (and smoother/faster than ever), the other methods of installation are not deprecated, and people use them all the time. Maybe you can file issues about the problems you ran into, or connect with some folks on slack to troubleshoot?

@rusackas
Copy link
Member

If we can help whatever situation is happening on your machine, maybe we can add some helpful documentation steps rather than kill off these installation methods.

@surapuramakhil
Copy link
Author

surapuramakhil commented Apr 25, 2024

When I left installation steps, these were issues

  1. From local setup docs - 1 errors was superset_config.py should be set in evn variable - that instruction was mission

It would install apache-superset as pip dependency.
1 was specific to brew - where it expected mysqClient should be brew. (it was complaining since I have installed MySQL via official installer)

  1. when I did https://superset.apache.org/docs/installation/pypi, when did
    superset run -p 8088 --with-threads --reload --debugger

Server starts - (UI is not identical). After you give creds which you created while init, you see blank screen only two boxes are show.

@sfirke
Copy link
Contributor

sfirke commented Apr 25, 2024

@surapuramakhil I made some updates to the PyPI instructions, do you have feedback on this PR: https://github.com/apache/superset/blob/58c25238fee96c89203184dd2badda7a4f06aa35/docs/docs/installation/pypi.mdx

@john-bodley john-bodley requested a review from sfirke April 26, 2024 17:28
@john-bodley john-bodley added the review:checkpoint Last PR reviewed during the daily review standup label Apr 26, 2024
@sfirke
Copy link
Contributor

sfirke commented Apr 29, 2024

Last week I tried to install from PyPI following Superset's docs and it did not work. That is a bad state of affairs, I agree. And this PR helped bring my attention to that. But I think the appropriate fix is to improve those instructions, not to mark those installation methods as deprecated. I'm going to close this PR in light of that. @surapuramakhil your feedback on my linked PR was already helpful, thank you! And I welcome further suggestions from you or anyone else as to how to improve those installation instructions.

@sfirke sfirke closed this Apr 29, 2024
@john-bodley john-bodley removed the review:checkpoint Last PR reviewed during the daily review standup label Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Namespace | Anything related to documentation size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants