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

New Tutorials! #5538

Merged
merged 84 commits into from
Sep 24, 2024
Merged

New Tutorials! #5538

merged 84 commits into from
Sep 24, 2024

Conversation

royendo
Copy link
Contributor

@royendo royendo commented Aug 28, 2024

A big one,

Introducing Tutorials!
This will create a new tab in the header for our docs (some reorganizing here) for a tutorial based section.

The topics that are here are part of a new github example project that will be added when this tutorial is released.
The main topics are

  • Rill Developer to Rill Cloud in 5 steps!
  • Rill Advanced Features
  • Adminsitration Topics
  • Rill and ClickHouse to Dashboarding in 4 steps!
  • Other topics

The main idea is that for "most" of these tutorials, they will have a 1to1 to a file in the github sample project. I decided to remove some of the Rill Cloud features as we should just have these better documented in the docs section.

Table of Contents:
Screenshot 2024-08-28 at 11 42 52

alextautu and others added 30 commits July 23, 2024 11:44
Rill tutorial courses

- I had to run npm install sidebar to get the tutorial page loaded but it added some dependencies, i think this is fine?
Added some blank pages to start the backbone for 100 courses
continued building out the 100 courses from Notion,

have some Q's around article length and whether we want to keep the height of all the articles uniform so the 'next' button doesn't vary... thoughts?
Continuing adding contents till 103.

Once dataset is ready, will need to go back and add details and media contents.
Will need to return to add the details but probably good enough for POC?
Feedback required: What do you think of the GIFs instead? I do think it looks cleaner and loads faster. We could either host them in our website or in gcs/public-data
Added some blank lists for the UI experience when ready to be added [can make it hidden until needed]
some extra stuff for early 200 courses..
…ldata/rill into initial_docs_tutorials_section
Always forget to push stuff,

re-created the GIFs for a cleaner UI.
some UI updates coming in 0.48. so paused on some contents,

outlining some 200 series contents, for chronological storytelling
Cleaned up 100s, forgot to add the model's SQL join,

added `coming soon` to the UI related stuff

getting confirmation on adding `fun` GIFs.
Added some topics for Guides,
Added some work to Rill/CH - how similar to Rill basics?
Added some further backbone into 200 series
masked the UI and RillCH courses with coming soon!
came up with some advanced SQL for 200 course models, i think this will be good enough to wrap up the 200 series once the underlying dataset is complete :)
Pushing current changes before working on the changes for 0.48 - UI Deploy
Additional Templates available soon :

- Pie Chart
- Table
Copy link
Contributor

Choose a reason for hiding this comment

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

Will be available on release

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sweet!


In this section, we'll cover how to create custom dashboards in Rill Developer and publish these to Rill Cloud,

:::note
Copy link
Contributor

Choose a reason for hiding this comment

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

Should go live in 0.50 so we could probably omit this section if we intend the tutorials to go out at the same time


Edit the rill.yaml via the UI and add the following:
```
features:
Copy link
Contributor

Choose a reason for hiding this comment

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

See above comment re release timing.

@royendo
Copy link
Contributor Author

royendo commented Sep 4, 2024

@mindspank How do you prefer having all the tutorials sub menus also open like the docs are, or have those selectable (as it is now)?

Still needs examples for all the new charts
Added a failing dashboard and alerts. I dont think alerting is available in Rill Cloud yet so will wait for 0.49 release then add screenshot of email.
As discussed in
https://rilldata.slack.com/archives/C07EBKZR2V7/p1726585781765539?thread_ts=1726579146.635389&cid=C07EBKZR2V7

once tutorials are live, will pull changes to canvas dashboard branch and uncomment the section.
We dont quite have a data warehouse ready to be used publicly so will make it coming soon!
@royendo royendo added Type:Documentation Improvements or additions to documentation good first issue Good for newcomers and removed blocker A release blocker issue that should be resolved before a new release labels Sep 18, 2024
Seems like a lot of changes coming from canvas, API, and incremental.

Instead of having confusing changing information, will release this section when clarified!
@royendo royendo merged commit 9d58678 into main Sep 24, 2024
5 checks passed
@royendo royendo deleted the initial_docs_tutorials_section branch September 24, 2024 17:20
@royendo royendo restored the initial_docs_tutorials_section branch September 24, 2024 17:30
@royendo royendo deleted the initial_docs_tutorials_section branch September 24, 2024 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers Type:Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants