Skip to content

Conversation

amotl
Copy link
Member

@amotl amotl commented Nov 15, 2024

About

Coming from reworking the Feature » Connectivity page, we are evaluating whether and how to optimally present code snippets that demonstrate connectivity better than just enumerating the drivers. Also, because it may not exclusively be about drivers only, but also about applications and others.

Preview

https://cratedb-guide--138.org.readthedocs.build/feature/connectivity/

@cla-bot cla-bot bot added the cla-signed label Nov 15, 2024
Base automatically changed from amo/feature-connectivity to main November 15, 2024 18:07
@amotl
Copy link
Member Author

amotl commented Aug 5, 2025

Let's evaluate how/where to fit this in after GH-221 has been merged, when applicable.

This patch includes concise driver usage information about all sorts of... It demonstrates relaying all the many possibilities through a tabbed view, and uses collapsible elements as a second variant, both for demonstration purposes and as a baseline for discussions.

Please let us know what you think about it, and which variant you would prefer, or a combination of both?

/cc @karynzv, @hammerhead, @surister, @kneth, @bmunkholm, @joncombe

@amotl amotl changed the title Feature/Connectivity: Add minimal code snippets for individual drivers Connect: Add minimal code snippets for individual drivers Aug 11, 2025
@kneth
Copy link
Member

kneth commented Aug 15, 2025

I like the collapsed ones, and I think we should move golang and node-crate into it too.

A little nitpick: could we use the same query in all the code snippets?

@amotl
Copy link
Member Author

amotl commented Aug 15, 2025

I like the collapsed ones, and I think we should move golang and node-crate into it too.

Yeah, we can move snippets for each and every driver into the collapsibles, if we decide we'd favor them. Thanks!

A little nitpick: could we use the same query in all the code snippets?

Sure. Isn't it always SELECT * FROM sys.summits LIMIT 3, where only on some the LIMIT 3 clause is missing?

@kneth
Copy link
Member

kneth commented Aug 21, 2025

@amotl

Isn't it always [...]

Yes, let add LIMIT 3 to all for consistency

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants