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] User tutorial #8459

Merged
merged 8 commits into from
Nov 8, 2019

Conversation

francishemingway
Copy link
Contributor

@francishemingway francishemingway commented Oct 27, 2019

CATEGORY

Choose one

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

SUMMARY

A new tutorial that focusing more on how an end user might use Superset, rather than how an administrator might set it up and get it working for the first time. I have added this as a new rst file, and changed the hierarchy within the documents so that there's now a tutorials page, with links to the existing tutorial and the new one.

The tutorial starts with basic instructions on how to load CSV data into superset and create a visualization. It then progresses through some different visualizations (pivot, bar chart, line chart), dashboard elements (filters, markdown and publishing). Then, it covers some more advanced features: advanced analytics and annotations.

Here's a screenshot of the new hierarchy of tutorials:
image

Full text of the tutorial is here (you should be able to comment).

ADDITIONAL INFORMATION

This tutorial is based on a real dataset from here which is a set of flights taken by an organization in 2011. This data is licensed under the Open Government Licence v3.0, an ASF category A license. Then it was combined with data from here, licensed under the public domain. Then I tidied it up by removing a single line (a flight with the same origin and destination). It's currently on my github.

Questions I have:

It would be great to get some guidance on the following:

  • Is there somewhere within the project's repositories to host the data file.
  • Should I open a new issue? This addresses more fully Tutorials #698.

@francishemingway francishemingway changed the title [WIP] User tutorial [docs] User tutorial Oct 29, 2019
@codecov-io
Copy link

codecov-io commented Oct 29, 2019

Codecov Report

Merging #8459 into master will increase coverage by 0.09%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #8459      +/-   ##
==========================================
+ Coverage   66.58%   66.68%   +0.09%     
==========================================
  Files         448      449       +1     
  Lines       22492    22687     +195     
  Branches     2364     2366       +2     
==========================================
+ Hits        14976    15128     +152     
- Misses       7378     7421      +43     
  Partials      138      138
Impacted Files Coverage Δ
superset/db_engine_specs/oracle.py 66.66% <0%> (-25%) ⬇️
superset/db_engine_specs/mssql.py 48.83% <0%> (-9.5%) ⬇️
superset/db_engine_specs/impala.py 59.09% <0%> (-5.91%) ⬇️
superset/db_engine_specs/sqlite.py 66.66% <0%> (-4.31%) ⬇️
superset/db_engine_specs/bigquery.py 42.66% <0%> (-2.41%) ⬇️
superset/views/database/__init__.py 78.78% <0%> (-1.22%) ⬇️
.../explore/components/controls/DatasourceControl.jsx 67.74% <0%> (-1.01%) ⬇️
superset/db_engine_specs/postgres.py 83.33% <0%> (-0.54%) ⬇️
.../assets/src/SqlLab/components/TabbedSqlEditors.jsx 83.03% <0%> (-0.3%) ⬇️
superset/views/core.py 71.96% <0%> (-0.25%) ⬇️
... and 28 more

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 eaeed0c...deec84d. Read the comment docs.

@etr2460
Copy link
Member

etr2460 commented Nov 4, 2019

This looks awesome, would you mind attaching some screenshots of the new documentation to make it a bit easier to review?

also, @sylvia-tomiyama you might be interested in this

@francishemingway
Copy link
Contributor Author

@etr2460 , @sylvia-tomiyama
I have added a screenshot to show the new organization of tutorials. Below that I've linked to the text in a google doc (it's about 2,500 words, so it's not going to fit in a screenshot). You should be able comment - let me know if not.

@etr2460
Copy link
Member

etr2460 commented Nov 5, 2019

Great, that's perfect! To answer your other questions:

I'll review and accept once the examples data PR is done and the link is replaced here

Copy link
Member

@willbarrett willbarrett left a comment

Choose a reason for hiding this comment

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

I saw a few minor language tweaks that could be good, my only blocker is moving the data to the already-recommended repo. Thank you very much for doing this!

docs/usertutorial.rst Outdated Show resolved Hide resolved
docs/usertutorial.rst Outdated Show resolved Hide resolved
docs/usertutorial.rst Outdated Show resolved Hide resolved
docs/usertutorial.rst Outdated Show resolved Hide resolved
docs/usertutorial.rst Outdated Show resolved Hide resolved
@francishemingway
Copy link
Contributor Author

@willbarrett - thanks very much for your feedback!

@etr2460 - I have created a pull request in the other repo here and I've updated the URL in this pull request to reflect where the new file will be.

docs/usertutorial.rst Outdated Show resolved Hide resolved
docs/usertutorial.rst Outdated Show resolved Hide resolved
docs/usertutorial.rst Outdated Show resolved Hide resolved
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.

The other PR is merged now, so once you address the other comments this should be good to go!

@francishemingway
Copy link
Contributor Author

@etr2460 I've updated based on all of the feedback now. Unless there's any more feedback, should be good to go.

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.

lgtm, thanks for adding all this documentation!

@mistercrunch mistercrunch merged commit 5ed2190 into apache:master Nov 8, 2019
graceguo-supercat pushed a commit that referenced this pull request Nov 13, 2019
* added user tutorial and rearranged docs hierarchy

* added license header, renamed admin tutorial file

* fixed image url issue

* Fix spelling

* Tweaks to text based on feedback

* guilabel and menu test

* added guilabel and upload csv section

* tidy up of rst formatting
@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 🚢 0.36.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants