-
Notifications
You must be signed in to change notification settings - Fork 14.4k
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
[docs] User tutorial #8459
Conversation
Codecov Report
@@ 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
Continue to review full report at Codecov.
|
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 |
@etr2460 , @sylvia-tomiyama |
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 |
There was a problem hiding this 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!
@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. |
There was a problem hiding this 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!
@etr2460 I've updated based on all of the feedback now. Unless there's any more feedback, should be good to go. |
There was a problem hiding this 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!
* 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
CATEGORY
Choose one
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](https://user-images.githubusercontent.com/45243854/68161667-59ae2000-ff24-11e9-955a-aa9965f01fbe.png)
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: