chore(docs): reorder, clarify PyPI installation

[sfirke]

SUMMARY

I tried installing from PyPI and found that some steps were missing or out of order. I removed irrelevant text, added other instructions, and reordered things.

Any concerns about suggesting that people install into a directory /superset and set up their virtual environment there?

There's now some redundancy with Configuring Superset docs, as they also talk about creating a superset_config.py file. Because the proper time to create one is in the install phase, when you are specifying a SECRET_KEY, I feel this belongs in this page. I think we should add the corresponding creating-a-config content to the install methods, then remove from Configuring Superset as everyone will have done it by that point.

TESTING INSTRUCTIONS

Follow these steps on a fresh Linux machine and see if they work. Please test!

[surapuramakhil]

Note: I am not an official review/maintainer. As you are requested for feedback added my comments

[sfirke]

Those are great additions, thanks @surapuramakhil !

[artofcomputing]

I think we should add the corresponding creating-a-config content to the install methods, then remove from Configuring Superset as everyone will have done it by that point.

I agree, Configuring Superset should be about options available after Installation, much like day-to-day administration of a environment.

[sfirke]

I agree, Configuring Superset should be about options available after Installation, much like day-to-day administration of a environment.

@artofcomputing I have added this to the BugHerd task board.

[john-bodley]

Hmmm. I'm a tad confused. Shouldn't the virtualenv be called venv—assuming it's inside the root superset folder?

[sfirke]

Right now the docs don't say to make a folder called superset, that's something I'm adding here. I believe what they say currently makes a virtualenv called venv in the root directory, which is not descriptive and potentially a problem if another tutorial says to do the same.

Now maybe mkdir superset is unnecessary if python3 -m venv superset below would create the directory.

I may be misunderstanding though, I'm new to this aspect.

[john-bodley]

I think we still want to keep pyenv documentation around, i.e., developers may want to switch which Python environment they want to use. In essence pyenv is a precursor to setting up Superset.

[sfirke]

Again I'm new to this but my newbie perspective was: the docs say:

You can create and activate a virtual environment using: [virtual env instructions] ... Or with pyenv-virtualenv:

I was unclear, which should I use? And when I read a little about it, it seemed like the venv was the most widely-used and so I eliminated an alternative.

If we should include both, can someone add a note to help a user decide which to use?