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: populate docs with ibis-examples repo content #8226

Merged
merged 2 commits into from
Feb 8, 2024

Conversation

cpcloud
Copy link
Member

@cpcloud cpcloud commented Feb 5, 2024

Moves content except for Substrait.ipynb to a new Examples tab in our documentation. Substrait.ipynb has multiple issues which need to be addressed if we want to include it. I opted for not including it at the moment.

@cpcloud cpcloud added the docs Documentation related issues or PRs label Feb 5, 2024
@cpcloud
Copy link
Member Author

cpcloud commented Feb 5, 2024

Substrait.ipynb issues:

  • The downloaded duckdb database doesn't work with 9.2, easily remedied by using ibis.duckdb.connect() on the server and populating that with penguins data from examples
  • DuckDB's substrait extension doesn't seem to understand the annotated substrait functions like avg:fp64 or count:any. Not sure if we're generating incorrect protobufs, or the extension needs to be updated to handle them.

@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Feb 5, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Feb 5, 2024
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Feb 5, 2024

@lostmygithubaccount
Copy link
Member

meta-comment -- should these just fit elsewhere in the website? tutorials/how-to guides/blog posts?

@gforsyth
Copy link
Member

gforsyth commented Feb 5, 2024

  • DuckDB's substrait extension doesn't seem to understand the annotated substrait functions like avg:fp64 or count:any. Not sure if we're generating incorrect protobufs, or the extension needs to be updated to handle them.

it's an issue with the extension, although I thought they had fixed it.
substrait-io/duckdb-substrait-extension#65

Might be they haven't released the updated extension?

@cpcloud
Copy link
Member Author

cpcloud commented Feb 5, 2024

should these just fit elsewhere in the website? tutorials/how-to guides/blog posts?

I think anywhere but blogs is fine. I think these are probably good to go in how-tos maybe in a data analysis subsection (?): not long enough for a tutorial and usually specific to a problem or dataset.

@cpcloud cpcloud force-pushed the roll-in-ibis-examples branch from fe9de4d to 7853984 Compare February 6, 2024 12:32
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@cpcloud cpcloud added this to the 9.0 milestone Feb 6, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@cpcloud cpcloud force-pushed the roll-in-ibis-examples branch from 7853984 to 6adb627 Compare February 6, 2024 12:35
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@cpcloud
Copy link
Member Author

cpcloud commented Feb 6, 2024

Moved:

  • duckdb-parquet to docs/how-to/input-output
  • clickhouse-hackernews to docs/data-platforms/clickhouse-hackernews.qmd (I'm going to change this to be just clickhouse)
  • imdb to docs/how-to/analytics/imdb

@cpcloud cpcloud force-pushed the roll-in-ibis-examples branch from 6adb627 to 4841d13 Compare February 6, 2024 12:37
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@cpcloud cpcloud force-pushed the roll-in-ibis-examples branch from 4841d13 to 86482c9 Compare February 6, 2024 12:39
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@cpcloud cpcloud force-pushed the roll-in-ibis-examples branch from 86482c9 to bfa156e Compare February 6, 2024 12:40
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Feb 6, 2024

@cpcloud
Copy link
Member Author

cpcloud commented Feb 6, 2024

Tried this out in a dev container, looks good!

image

@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Feb 6, 2024

@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Feb 6, 2024

@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Feb 6, 2024

@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Feb 6, 2024

@cpcloud cpcloud force-pushed the roll-in-ibis-examples branch from bfa156e to dcd16b5 Compare February 6, 2024 13:08
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@cpcloud cpcloud force-pushed the roll-in-ibis-examples branch from dcd16b5 to b4cf23e Compare February 6, 2024 13:10
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Feb 6, 2024
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Feb 6, 2024

@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Feb 6, 2024

@cpcloud cpcloud changed the title docs: create examples tab and populate with ibis-examples repo content docs: populate docs with ibis-examples repo content Feb 7, 2024
@cpcloud
Copy link
Member Author

cpcloud commented Feb 7, 2024

@ncclementi @gforsyth @jcrist Any thoughts here?

We should add the substrait example back in once we get it working, but ideally we can merge this in in the mean time.

Copy link
Member

@gforsyth gforsyth left a comment

Choose a reason for hiding this comment

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

Yeah, I'm good with more things in how-to

docs/examples/clickhouse-hackernews.qmd Outdated Show resolved Hide resolved
@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Feb 8, 2024
@cpcloud cpcloud force-pushed the roll-in-ibis-examples branch from e6055f7 to 57bbd8b Compare February 8, 2024 13:38
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Feb 8, 2024
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Feb 8, 2024

@gforsyth gforsyth merged commit 897129c into ibis-project:main Feb 8, 2024
91 checks passed
@cpcloud cpcloud deleted the roll-in-ibis-examples branch February 8, 2024 14:19
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
None yet
Development

Successfully merging this pull request may close these issues.

3 participants