[CONTENT] Refactoring: Absorb tutorial-like references and content from crate-clients-tools #29
Conversation
amotl
force-pushed
the
amo/absorb-tutorial-references
branch
from
a9c8c03
to
c524ef9
Compare
amotl
changed the title
amotl
changed the title
amotl
force-pushed
the
amo/absorb-tutorial-references
branch
from
c524ef9
to
abc5746
Compare
| - [Importing Parquet files into CrateDB using Apache Arrow and SQLAlchemy] | ||
| - [Guide to efficient data ingestion to CrateDB with pandas] | ||
| - [Guide to efficient data ingestion to CrateDB with pandas and Dask] | ||
| - [Efficient batch/bulk INSERT operations with pandas, Dask, and SQLAlchemy] | ||
| - [pandas code examples] | ||
| - [Dask code examples] | ||
| - Polars | ||
| - [Polars code examples] |
There was a problem hiding this comment.
Is this the right place for this content? Section is about connect while this content looks more like integrations.
Should we add a pandas or so section to the integrations section instead? This would also highlight it better I think.
There was a problem hiding this comment.
I will see what I can do here while compressing the whole "Getting Started" section into a single page, as suggested. Thanks.
There was a problem hiding this comment.
Corresponding improvements have been implemented on behalf of a separate PR, in order to make reviewing easier, and to separate concerns.
| @@ -157,6 +157,7 @@ reference-architectures/index | |||
| topic/analysis/index | |||
| topic/timeseries/index | |||
| topic/ml/index | |||
| topic/testing | |||
There was a problem hiding this comment.
Can we re-order the entries here so that the reference-architecture is not in the middle of integrations and topics? I'd suggest to move the reference-architecture up before integrations.
There was a problem hiding this comment.
Sure, we can have a look how this looks like, independently of semantic matters. Thanks.
There was a problem hiding this comment.
Implemented with 2b4b45d on behalf of a separate PR, stacked upon this one.
|
|
||
| After executing the second SQL statement, the "nyc_taxi" table will be | ||
| populated with data. Depending on your cluster configuration this can take | ||
| around 40 minutes. |
There was a problem hiding this comment.
Can a smaller data-set be used? Waiting 40min for a demo feels too long to me.
There was a problem hiding this comment.
I agree. However, I am not touching the content too much on this iteration, so we need to carry this over into a subsequent round of content editing, which is definitively planned after the current round of structural improvements. Thanks for spotting!
There was a problem hiding this comment.
Diverted into an issue, thanks again.
|
|
||
| # Data Analysis and Visualization | ||
|
|
||
| This section of the documentation covers integrations of CrateDB with other |
There was a problem hiding this comment.
This talks also about integrations, such I wonder if we should merge all this content into the integrations section. Otherwise it feels a bit weird to me, some stuff resides inside the integration section while other not while the content seems to be all about integrations. What is the reasoning for this separation? It's not clear to me as a reader...
There was a problem hiding this comment.
This is right on the spot! I've certainly also identified this as a smell, but continued to bring in the content first. On another iteration here, within the scope of this PR, I will adjust the page layout to reflect the structure of https://cratedb.com/docs/clients/ as the baseline for further discussions. Thanks again!
|
Building upon the comments shared above, @seut suggested a few more details. Thanks.
The first two items will be addressed on behalf of this PR, the second two items are not easy to achieve right now, and need to be postponed into a subsequent iteration. |
Previously, a bit of tutorial-like material, mostly in form of references/links has been slotted into crate-clients-tools as an interim solution. Let's have them play on the main stage now.
amotl
force-pushed
the
amo/absorb-tutorial-references
branch
from
abc5746
to
8f4ac5f
Compare
amotl
requested review from
surister and
seut
and removed request for
hammerhead and
hlcianfagna
About
Previously, a bit of tutorial-like material, mostly in form of references/links, has been slotted into crate-clients-tools as an interim solution. Let's have them play on the main stage now.
Status
This patch is merely a content transfer / refactoring, without adding any style yet. The outcome currently has many walls of links, which is unpleasant. Sure enough, more can be done on behalf of subsequent iterations, in order to provide better appearance and guidance. For this patch, we can be happy enough that the content finally found the right slot.
Preview
Backlog
When integrating this patch, this other one can be merged afterwards, in order to conclude the content migration.
/cc @karynzv, @marijaselakovic, @matkuliak, @hammerhead, @hlcianfagna, @surister, @proddata, @ckurze, @stephanec76