-
Notifications
You must be signed in to change notification settings - Fork 0
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
Feature/Connectivity: Rework page #135
Conversation
docs/feature/connectivity/index.md
Outdated
::::::{tab-set} | ||
|
||
:::::{tab-item} C# / Npgsql | ||
For more information see [Npgsql] documentation. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's the "tabbed" variant. We think it will not scale, and nesting tabs is also debatable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, on a small screen (14 in laptop) it is not an optimal solution
docs/feature/connectivity/index.md
Outdated
:::::{dropdown} PHP | ||
|
||
:::{rubric} HTTP | ||
::: | ||
|
||
::::{dropdown} PDO_CRATEDB | ||
The PHP Data Objects (PDO) is a standard PHP extension that defines a common | ||
interface for accessing databases in PHP. | ||
For more information see [CrateDB PDO] documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's the "dropdown" variant, already using nested dropdowns, immediately applicable with PHP and Python for example, as there are many driver variants for them, across two families (HTTP vs. PostgreSQL), which stretches all axes of the system needed to represent those.
We are biased to use this variant, and drop the "tabbed" variant again. wdyt?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The main question to you here is if you agree to continue with the "dropdown" variant, because the "tabbed" variant doesn't scale well. Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we go with the "tabbed" variant, I think we should pick 3-4 items only. So if we want to have all items, the "dropdown" variant might be better.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. I tried to present both variants without many initial plans, and just related to a recent comment from your pen that you like "tabbed" approaches of information conveyance, if I got that right.
What do you think how we should proceed on this particular matter?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, on a small screen (14 in laptop), "tabbed" variant is not an optimal solution.
It looks like I've missed your other reply. Thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your suggestions. I've diverted corresponding updates into a separate patch that needs more love, in order to get this one merged.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have only minor suggestions
docs/feature/connectivity/index.md
Outdated
|
||
:::{rubric} Overview | ||
::: | ||
All the CrateDB connectivity options at a glance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All the CrateDB connectivity options at a glance. | |
CrateDB connectivity options at a glance. |
docs/feature/connectivity/index.md
Outdated
properties.put("password", ""); | ||
properties.put("ssl", false); | ||
Connection conn = DriverManager.getConnection( | ||
"jdbc:crate://localhost:5432/", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please consider to add a comment here about the two different drivers
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. Do you agree with that variant?
cratedb-guide/docs/feature/connectivity/index.md
Lines 183 to 197 in 525483f
// You can use both drivers, vanilla pgJDBC, or CrateDB's pgJDBC. | |
String dburi = "jdbc:crate://localhost:5432/"; | |
String dburi = "jdbc:postgresql://localhost:5432/"; | |
public class Main { | |
public static void main(String[] args) { | |
try { | |
Properties properties = new Properties(); | |
properties.put("user", "crate"); | |
properties.put("password", ""); | |
properties.put("ssl", false); | |
Connection conn = DriverManager.getConnection( | |
dburi, | |
properties | |
); |
- => See: Feature/Connectivity: Add minimal code snippets for individual drivers #138. Please respond there to further improve that section. For example, we could add inline comments or a link to the relevant documentation page, when applicable.
1da6832
to
c85d0e9
Compare
... like others in the same section.
c85d0e9
to
c1c3015
Compare
Problem
The Feature » Connectivity page wasn't in a good shape yet. @kneth discovered that recently.
Solution
This patch intends to converge the page into the same layout/shape/style like all the others in the "All Features" section, using the same compact backbone made of "Intro", "Synopsis", and "Learn" subsections.
Preview
https://cratedb-guide--135.org.readthedocs.build/feature/connectivity/
Review
Details
This refactors a bit of content from a few sibling pages in crate-clients-tools. 1
Demonstrate two different variants for single-page client-/driver-snippets presentation, one using tabs, and another one using dropdowns.
Footnotes
crate-clients-tools might be dissolved in the future, in order to reduce maintenance overhead, so it's a good idea to migrate content gradually. ↩