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: revamp the how-to guides #8855

Closed
46 tasks
Tracked by #8857
lostmygithubaccount opened this issue Apr 2, 2024 · 0 comments
Closed
46 tasks
Tracked by #8857

docs: revamp the how-to guides #8855

lostmygithubaccount opened this issue Apr 2, 2024 · 0 comments
Assignees
Labels
docs Documentation related issues or PRs

Comments

@lostmygithubaccount
Copy link
Member

From diataxis.fr:

How-to guides are directions that guide the reader through a problem or
towards a result. How-to guides are goal-oriented.


A how-to guide helps the user get something done, correctly and safely; it
guides the user’s action.

It’s concerned with work - navigating from one side to the other of a
real-world problem-field.

The current Ibis how-to guides are better than before, but lacking. This issue
lays out a proposed structure and articles for discussion/implementation over
the new few months. Opening for public feedback as well. If you have ideas, or
something's missing, please comment below!

I'll use bold for section headers and TODO lists for individual articles.

Configuration

  • Interactive mode (including max rows/columns etc.)
  • Default backend
  • ...

Input and output

  • Work with tables and views
  • Work with CSV
  • Work with Parquet
  • Work with JSON
  • Work with Delta Lake tables
  • Work with cloud storage (possible 1 per AWS/Azure/GCP)
  • ...

Analytics

  • Selecting and dropping columns (link out to advanced selectors topic?)
  • Filter
  • Aggregate
  • Group by
  • Order
  • Slice
  • Case statements
  • Add new columns (mutate)
  • Join (merge tables)
  • Cast to different datatypes
  • Append data (union)
  • Window functions
  • Chaining expressions and the underscore API
  • Work with numbers and booleans
  • Work with strings
  • Work with structs
  • Work with arrays
  • Work with selectors
  • ...

Work with SQL

  • Use existing SQL code
  • Produce SQL code
  • ...

User-defined functions (UDFs)

  • Scalar built-in UDFs
  • Scalar Python UDFs
  • Scalar PyArrow UDFs
  • Scalar pandas UDFs

Geospatial operations

  • ...

Visualiztion

  • altair
  • graphViz
  • matplotlib
  • plotly
  • plotnine
  • seaborn
  • streamlit
  • ...

Extending

  • ...
@lostmygithubaccount lostmygithubaccount added the docs Documentation related issues or PRs label Apr 2, 2024
@lostmygithubaccount lostmygithubaccount self-assigned this Apr 2, 2024
@lostmygithubaccount lostmygithubaccount closed this as not planned Won't fix, can't repro, duplicate, stale Sep 29, 2024
@github-project-automation github-project-automation bot moved this from backlog to done in Ibis planning and roadmap Sep 29, 2024
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
Projects
Archived in project
Development

No branches or pull requests

1 participant