Skip to content

Commit 3fa7d9d

Browse files
authored
docs: Fix inconsistencies in documentation (#2190)
This PR fixes some typos and formatting artifacts in the documentation files. It also removes the `version: ` field from the Docker Compose setup instruction, as it is [obsolete](https://docs.docker.com/reference/compose-file/version-and-name/#version-top-level-element-obsolete). > Compose always uses the most recent schema to validate the Compose file, regardless of the version field. Note: I also noticed the version field in the `docker-compose.yml` files, but was unsure whether removing it would affect backward compatibility.
2 parents 2c2ab81 + 400403c commit 3fa7d9d

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

docs/ADMIN_API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The admin API is used to manage namespaces on a `sqld` instance. Namespaces are
66

77
To enable the admin API, and manage namespaces, two extra flags need to be passed to `sqld`:
88

9-
- `--admin-listen-addr <addr>:<port>`: the address and port on which the admin API should listen. It must be different from the user API listen address (whi defaults to port 8080).
9+
- `--admin-listen-addr <addr>:<port>`: the address and port on which the admin API should listen. It must be different from the user API listen address (which defaults to port 8080).
1010
- `--enable-namespaces`: enable namespaces for the instance. By default namespaces are disabled.
1111

1212
## Routes

docs/DOCKER.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ docker run --name some-sqld-replica -p 8081:8080 -ti \
1717
-e SQLD_NODE=replica \
1818
-e SQLD_PRIMARY_URL=https://<host>:<port> \
1919
ghcr.io/tursodatabase/libsql-server:latest
20-
````
20+
```
2121

2222
## Running on Apple Silicon
2323

@@ -122,7 +122,6 @@ inter-node communication. Recommended to leave this on default.
122122
Simple docker compose for local development:
123123

124124
```yaml
125-
version: "3"
126125
services:
127126
db:
128127
image: ghcr.io/tursodatabase/libsql-server:latest

docs/USER_GUIDE.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Welcome to the `sqld` user guide!
2525
The `sqld` program provides libsql over HTTP and supports transparent replication.
2626

2727
![libsql cluster overview.](sqld-overview.png)
28+
2829
<p align="center">
2930
Figure 1. Overview of libsql clustering.
3031
</p>
@@ -82,7 +83,7 @@ You now have a `sqld` primary server listening to SQL over HTTP at `127.0.0.1:80
8283

8384
### Launching a replica server
8485

85-
To start a a `sqld` server in replica mode, run:
86+
To start a `sqld` server in replica mode, run:
8687

8788
```console
8889
sqld \
@@ -150,7 +151,7 @@ curl -X POST -d '{"statements": ["select * from testme"]}' $YOUR_APP.fly.dev
150151
```
151152

152153
```json
153-
[{"b":2,"a":1,"c":3}]
154+
[{ "b": 2, "a": 1, "c": 3 }]
154155
```
155156

156157
## Incremental snapshots
@@ -182,7 +183,7 @@ and then configure `sqld` to generate an incremental snapshot every 5 seconds an
182183
sqld --snapshot-exec ./snapshot.sh --max-log-duration 5
183184
```
184185

185-
When you write to the `sqld` database, you will eventually see log line such as:
186+
When you write to the `sqld` database, you will eventually see a log line such as:
186187

187188
```console
188189
2023-08-11T08:21:04.183564Z INFO sqld::replication::snapshot: snapshot `e126f594-90f4-45be-9350-bc8a01160de9-0-2.snap` successfully created
@@ -254,7 +255,7 @@ For example, if you have the following entries in your `/etc/hosts` file:
254255
127.0.0.1 db2.local
255256
```
256257

257-
You can access `db1` with the `http://db1.local:8080`URL and `db2` with `http://db2.local:8080`.
258+
You can access `db1` with the `http://db1.local:8080` URL and `db2` with `http://db2.local:8080`.
258259
The database files for the databases are stored in `<data dir>/dbs/db1` and `<data dir/dbs/db2`, respectively.
259260

260261
### Path based routing

libsql-server/perf/pgbench/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Setup database:
44

55
```console
66
psql -h 127.0.0.1 -p 5432 < pg_bench_schema.sql
7-
````
7+
```
88

99
Run `pgbench`:
1010

libsql-sqlite3/doc/testrunner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ If there is no permutation, the individual test script may be run with:
158158
./testfixture $PATH_TO_SCRIPT
159159
```
160160

161-
Or, if the failure occured as part of a permutation:
161+
Or, if the failure occurred as part of a permutation:
162162

163163
```
164164
./testfixture $TESTDIR/testrunner.tcl $PERMUTATION $PATH_TO_SCRIPT

0 commit comments

Comments
 (0)