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

Contributing/installation docs for release--0.31 are out of date #7373

Closed
1 task
rjurney opened this issue Apr 24, 2019 · 2 comments
Closed
1 task

Contributing/installation docs for release--0.31 are out of date #7373

rjurney opened this issue Apr 24, 2019 · 2 comments
Labels
inactive Inactive for >= 30 days

Comments

@rjurney
Copy link
Contributor

rjurney commented Apr 24, 2019

The documentation for branch release--0.31 are out of date and need improvement to work with the latest versions of Max OS X/XCode/homebrew and Linux/apt. Someone (me) should go through the contributing and install guides and work the install process for clean installs of both platforms and all common Pythons and update the documentation.

Expected results

I expect the CONTRIBUTING.md development environment setup instructions to be up to date and with all issues addressed for the latest platforms.

I expect the docs/installation.rst install instructions to have a prerequisites section includinf everything I need to install superset on my computer.

Actual results

I found multiple issues. Anaconda Python required specific instructions that weren't there. Prerequisites such as mysql_config were needed for development that weren't listed. Some packages didn't build without flags/prerequisites on both OS X and Linux.

Screenshots

If applicable, add screenshots to help explain your problem.

How to reproduce the bug

  1. Go to CONTRIBUTING.md and cross reference docs/installation.rst
  2. Follow the directions.
  3. See errors.

Environment

(please complete the following information):

  • superset version: [v0.31, b3aa5633, 0.31rc23]
  • python versions: [3.6.7, 3.7.3]
  • node.js version: v11.6.0
  • npm version: 6.5.0

Checklist

Make sure these boxes are checked before submitting your issue - thank you!

  • [*] I have checked the superset logs for python stacktraces and included it here as text if there are any.
  • I have reproduced the issue with at least the latest released version of superset.
  • [*] I have checked the issue tracker for the same issue and I haven't found one similar.

Additional context

Nein

@issue-label-bot
Copy link

Issue Label Bot is not confident enough to auto-label this issue. See dashboard for more details.

rjurney added a commit to rjurney/incubator-superset that referenced this issue Apr 26, 2019
rjurney added a commit to rjurney/incubator-superset that referenced this issue Apr 26, 2019
rjurney added a commit to rjurney/incubator-superset that referenced this issue May 1, 2019
@rjurney rjurney mentioned this issue May 1, 2019
12 tasks
mistercrunch pushed a commit that referenced this issue May 21, 2019
* resolved conflict

* Docs updated re: Anaconda/certifi issue re #7373

* Removed --console-log "not working" note

* A note about Anaconda virtualenvs

* Make anaconda comment fit on page

* Added README to docker directory

* Added install doc reference to master copy of contrib/docker/README.md

* merged master, removed mysqlclient

* Removed mysql dependency, Anaconda and --console-log references

* Add cypress install command to cypress test instructions

* Fixed cypress instructions re: port 8081

* Removed anaconda reference, runserver references

* Remove anaconda reference

* Added back a self-contained version of mysqlclient to dev requirements

* Added ASF license to docker README.md
@stale
Copy link

stale bot commented Jun 24, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. For admin, please label this issue .pinned to prevent stale bot from closing the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
inactive Inactive for >= 30 days
Projects
None yet
Development

No branches or pull requests

2 participants