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] Fix CORS section in installation #8958

Merged
merged 1 commit into from
Jan 16, 2020

Conversation

graceguo-supercat
Copy link

@graceguo-supercat graceguo-supercat commented Jan 13, 2020

CATEGORY

Choose one

  • Bug Fix
  • Enhancement (new features, refinement)
  • Refactor
  • Add tests
  • Build / Development Environment
  • Documentation

SUMMARY

Fix the extra CORS Dependency in Superset installation step.

TEST PLAN

https://superset.incubator.apache.org/installation.html#cors

ADDITIONAL INFORMATION

REVIEWERS

@michellethomas @mistercrunch @etr2460

@codecov-io
Copy link

codecov-io commented Jan 13, 2020

Codecov Report

Merging #8958 into master will decrease coverage by 0.29%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##           master    #8958     +/-   ##
=========================================
- Coverage   58.97%   58.68%   -0.3%     
=========================================
  Files         359      362      +3     
  Lines       11333    11415     +82     
  Branches     2787     2801     +14     
=========================================
+ Hits         6684     6699     +15     
- Misses       4471     4538     +67     
  Partials      178      178
Impacted Files Coverage Δ
...t/assets/src/dashboard/reducers/dashboardLayout.js 93% <0%> (-1.9%) ⬇️
...et/assets/src/dashboard/actions/dashboardLayout.js 95.09% <0%> (-1.88%) ⬇️
...uperset/assets/src/dashboard/components/Header.jsx 41.46% <0%> (-1.78%) ⬇️
...ssets/src/dashboard/containers/DashboardHeader.jsx 100% <0%> (ø) ⬆️
...src/dashboard/components/HeaderActionsDropdown.jsx 69.56% <0%> (ø) ⬆️
superset/assets/src/dashboard/reducers/index.js 100% <0%> (ø) ⬆️
...set/assets/src/dashboard/reducers/dashboardInfo.js 66.66% <0%> (ø)
...rset/assets/src/dashboard/actions/dashboardInfo.js 33.33% <0%> (ø)
...ssets/src/dashboard/components/PropertiesModal.jsx 7.4% <0%> (ø)
...src/dashboard/util/getFilterConfigsFromFormdata.js 88.46% <0%> (+1.5%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1f6f4ed...4e9b34d. Read the comment docs.

Copy link
Member

@etr2460 etr2460 left a comment

Choose a reason for hiding this comment

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

doc change seems fine. I'm a bit confused why you'd need to separately install another dep instead of it being included in requirements or requirements-extra, but i don't have the historical context

@graceguo-supercat
Copy link
Author

CORS is optional for Superset app. it's contributed by community:
#478
I guess most of users/companies don't need to handle cross-domain issue.

@villebro
Copy link
Member

What is the purpose of this change? If the purpose is to describe the process when not installing Superset via pip, then I think it might be better to explain when this alternative approach is needed.

@graceguo-supercat
Copy link
Author

I feel confused by the current instruction. I am ok with all options .

Before:
Screen Shot 2020-01-14 at 1 19 50 PM

After:
Screen Shot 2020-01-14 at 1 26 18 PM


pip install -U flask-cors
Copy link
Member

Choose a reason for hiding this comment

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

It's slightly better to recommend pip install apache-superset[cors], that way it will reference the version range or pinned version specified in setup.py

Copy link
Author

Choose a reason for hiding this comment

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

Updated.

@mistercrunch mistercrunch merged commit 2b0c7a1 into apache:master Jan 16, 2020
@mistercrunch mistercrunch deleted the gg-FixCORSDocs branch January 16, 2020 05:49
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.36.0 labels Feb 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/XS 🚢 0.36.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants