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): installing-superset-from-scratch guide gets complete, orderly #27082

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

AlphaJack
Copy link

Now guide can be followed directly: venv is the only Python environment mentioned, needed environmental variables are stored on a file and sourced from there. All superset commands can now be run without interruptions

SUMMARY

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

Now guide can be followed directly: `venv` is the only Python environment mentioned, needed environmental variables are stored on a file and sourced from there. All `superset` commands can now be run without interruptions
@github-actions github-actions bot added the doc Namespace | Anything related to documentation label Feb 12, 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.

@sfirke sfirke changed the title Update installing-superset-from-scratch.mdx chore(docs): installing-superset-from-scratch guide gets complete, orderly Feb 12, 2024
@sfirke
Copy link
Member

sfirke commented Feb 12, 2024

This looks like a wonderful PR! People get tripped up by these steps and the way you reordered and added necessary config variables should help a lot. It looks good to me, but I have never actually installed Superset from scratch (I only have deployed with Docker) so don't feel qualified to merge it myself. Hopefully someone else can take a quick peek, agrees with me, and we can merge ASAP.

Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

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

suggested one comment re: importance of not losing your secret key

AlphaJack and others added 2 commits February 13, 2024 10:05
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
Co-authored-by: John Bodley <4567245+john-bodley@users.noreply.github.com>
@AlphaJack
Copy link
Author

@sfirke Based on the "Installing from Scratch" guide I created superset-venv, an AUR package for Arch Linux users.

Unfortunately it was not possible to create a non-venv superset, as the app requires specific dependency versions, either too old or not yet available from Arch repos.

In both packages I included a message with the manual steps needed to finalize the installation.

@rusackas
Copy link
Member

I think the file this was editing is no longer there, as things got shuffled around a bit. This needs a rebase, but might also need additional tweaking after doing so. I'll convert it to a draft for the moment since it's not mergeable, but I hopeful that we can merge it soon if updates are made :) Thanks for the patience... we drowned in PRs for a bit, and are just coming around to some loose ends.

@rusackas rusackas marked this pull request as draft August 28, 2024 14:52
@sfirke
Copy link
Member

sfirke commented Aug 28, 2024

Doh, I didn't remember this when I made #28221 which overlaps heavily with this one. We can probably tackle both together.

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 review:draft size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants