Connect/Go: Copy editing

Author: amotl

docs/connect/go/index.md

@@ -13,6 +13,12 @@ The `pgx` and `pq` packages have been validated with CrateDB.
 `pq` is in maintenance mode, so their authors recommend using
 `pgx` which is under active development.
 
+The `KSQL` package is a convenience wrapper that also uses the
+`pgx` library to connect to CrateDB.
+
+:::{rubric} Overview
+:::
+
 :::{toctree}
 :hidden:
 pgx

docs/connect/go/ksql.md

@@ -74,14 +74,6 @@ func main() {
 }
 ```
 
-:::{include} ../_cratedb.md
-:::
-```shell
-go mod init github.com/cratedb-guide/connect/go/ksql
-go mod tidy
-go run example.go
-```
-
 :::{rubric} CrateDB Cloud
 :::
 
@@ -92,5 +84,18 @@ your environment.
 dbURL := "postgresql://admin:password@testcluster.cratedb.net:5432/doc?sslmode=require"
 ```
 
+:::{rubric} Quickstart example
+:::
+
+Create the file `example.go` including the synopsis code shared above.
+
+:::{include} ../_cratedb.md
+:::
+```shell
+go mod init github.com/cratedb-guide/connect/go/ksql
+go mod tidy
+go run example.go
+```
+
 
 [KSQL]: https://github.com/VinGarcia/ksql

docs/connect/go/pgx.md

@@ -61,14 +61,6 @@ func main() {
 }
 ```
 
-:::{include} ../_cratedb.md
-:::
-```shell
-go mod init github.com/cratedb-guide/connect/go/pgx
-go mod tidy
-go run example.go
-```
-
 :::{rubric} CrateDB Cloud
 :::
 
@@ -79,7 +71,20 @@ your environment.
 conn, _ := pgx.Connect(ctx, "postgresql://admin:password@testcluster.cratedb.net:5432/doc?sslmode=require")
 ```
 
-:::{rubric} Example
+:::{rubric} Quickstart example
+:::
+
+Create the file `example.go` including the synopsis code shared above.
+
+:::{include} ../_cratedb.md
+:::
+```shell
+go mod init github.com/cratedb-guide/connect/go/pgx
+go mod tidy
+go run example.go
+```
+
+:::{rubric} Full example
 :::
 
 :::{card}

docs/connect/go/pq.md

@@ -41,14 +41,6 @@ func main() {
 }
 ```
 
-:::{include} ../_cratedb.md
-:::
-```shell
-go mod init github.com/cratedb-guide/connect/go/pq
-go mod tidy
-go run example.go
-```
-
 :::{rubric} CrateDB Cloud
 :::
 
@@ -59,5 +51,18 @@ your environment.
 connStr := "postgresql://admin:password@testcluster.cratedb.net:5432/doc?sslmode=require"
 ```
 
+:::{rubric} Quickstart example
+:::
+
+Create the file `example.go` including the synopsis code shared above.
+
+:::{include} ../_cratedb.md
+:::
+```shell
+go mod init github.com/cratedb-guide/connect/go/pq
+go mod tidy
+go run example.go
+```
+
 
 [pq]: https://github.com/lib/pq