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(tutorials): reorganize the "Getting started" tab #10936

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

romaingd
Copy link
Contributor

@romaingd romaingd commented Mar 4, 2025

Description of changes

Reorganizes the "Getting started" tab layout according to discussions in #8197.
This required re-running most tutorials, and fixing a couple of issues on the way - see comments.
Links and redirections were updated to match the new structure - hopefully I haven't missed any!

I can easily split the PR into smaller ones if it makes the review easier.

Comparison

Before After
image image
image image

Choices

I've tried to reach a layout that makes sense for new users (including myself). Some choices that differ from previous discussions:

  • "10 minutes to Ibis" replaces "Tutorial: getting started"
    • matches similar sections in the docs of pandas or Dask
    • avoids repeating "Getting started" which is already the tab name
  • "Coming from" replaces "Ibis for X users"
    • I find it more intuitive (especially now that X is a known platform)
    • pandas sometimes uses "Coming from", sometimes "Comparison with". polars uses "Migrating > Coming from [...]". Overall "Coming from" seems usual.
  • "Backend examples" replaces "Backends"
    • avoids mistaking it for a list of supported backends

I'm still new to Ibis, so let me know if other names would be more appropriate!

Issues closed

@github-actions github-actions bot added docs Documentation related issues or PRs tests Issues or PRs related to tests labels Mar 4, 2025
Copy link
Contributor Author

@romaingd romaingd Mar 4, 2025

Choose a reason for hiding this comment

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

As explained in #10932, the Flink tutorial failed at some point. To re-generate the output, I had to cheat a little and use copy=True (without committing the change). Given that the results were correct, and that the tutorial is already broken on main, that seemed like an acceptable shortcut to me for this PR.

).agg(
user_mean_trans_amt_last_360min=windowed_stream.amt.mean(),
user_trans_count_last_360min=windowed_stream.amt.count(),
user_mean_trans_amt_last_360min=ibis._.amt.mean(),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Conflicted with for _, msg in zip(range(10), consumer):

@@ -23,10 +23,10 @@ ibis.options.interactive = True # <2>

load_dotenv() # <3>

user = os.getenv("USERNAME") # <4>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

"USERNAME" conflicted with my Linux user. Using prefixed environment variables seemed more robust to me anyway.

Copy link
Member

Choose a reason for hiding this comment

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

Yep, totally fine!

@romaingd romaingd marked this pull request as ready for review March 4, 2025 20:34
@@ -135,19 +135,9 @@ ibis/examples/descriptions
ci/odbc/odbc.ini
*-citibike-tripdata.tar.xz

# data downloaded by the geospatial tutorial
docs/posts/ibis-duckdb-geospatial/nyc_data.db.wal
Copy link
Member

@cpcloud cpcloud Mar 4, 2025

Choose a reason for hiding this comment

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

Good idea moving all this stuff into a docs/.gitignore. I definitely forget about simple solutions to .gitignore sprawl!

- auto: tutorials/cloud-data-platforms
- auto: tutorials/open-source-software
- tutorials/browser/repl.qmd
- section: Coming from
Copy link
Member

Choose a reason for hiding this comment

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

How do you feel about

Coming from …

with the horizontal ellipsis?

@@ -1,5 +1,5 @@
---
title: JupyterLite console
title: Try it online
Copy link
Member

Choose a reason for hiding this comment

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

How about

Online playground

?

Or if we keep Try it online can we add an exclamation mark at the end?

Copy link
Member

@cpcloud cpcloud left a comment

Choose a reason for hiding this comment

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

Generally speaking, excellent work.

Very thorough, and it looks like you covered all the annoying bases (e.g., redirects and adjusting paths).

+1 from me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related issues or PRs tests Issues or PRs related to tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: reorganize the tutorials tab
2 participants