From c0bef53f3ba3b2b1c0a11979053baf4b0e9b6b75 Mon Sep 17 00:00:00 2001 From: Lucio Franco Date: Tue, 14 Nov 2023 10:28:20 -0500 Subject: [PATCH 1/2] docs: move docs to root of repo --- {libsql-server/docs => docs}/BUILD-RUN.md | 0 {libsql-server/docs => docs}/CONSISTENCY_MODEL.md | 0 {libsql-server/docs => docs}/DESIGN.md | 0 {libsql-server/docs => docs}/DOCKER.md | 0 {libsql-server/docs => docs}/HRANA_1_SPEC.md | 0 {libsql-server/docs => docs}/HRANA_2_SPEC.md | 0 {libsql-server/docs => docs}/HRANA_3_SPEC.md | 0 {libsql-server/docs => docs}/HTTP_V1_SPEC.md | 0 {libsql-server/docs => docs}/HTTP_V2_SPEC.md | 0 {libsql-server/docs => docs}/USER_GUIDE.md | 0 {libsql-server/docs => docs}/http_api.md | 0 .../docs => docs}/sqld-overview.excalidraw | 0 {libsql-server/docs => docs}/sqld-overview.png | Bin 13 files changed, 0 insertions(+), 0 deletions(-) rename {libsql-server/docs => docs}/BUILD-RUN.md (100%) rename {libsql-server/docs => docs}/CONSISTENCY_MODEL.md (100%) rename {libsql-server/docs => docs}/DESIGN.md (100%) rename {libsql-server/docs => docs}/DOCKER.md (100%) rename {libsql-server/docs => docs}/HRANA_1_SPEC.md (100%) rename {libsql-server/docs => docs}/HRANA_2_SPEC.md (100%) rename {libsql-server/docs => docs}/HRANA_3_SPEC.md (100%) rename {libsql-server/docs => docs}/HTTP_V1_SPEC.md (100%) rename {libsql-server/docs => docs}/HTTP_V2_SPEC.md (100%) rename {libsql-server/docs => docs}/USER_GUIDE.md (100%) rename {libsql-server/docs => docs}/http_api.md (100%) rename {libsql-server/docs => docs}/sqld-overview.excalidraw (100%) rename {libsql-server/docs => docs}/sqld-overview.png (100%) diff --git a/libsql-server/docs/BUILD-RUN.md b/docs/BUILD-RUN.md similarity index 100% rename from libsql-server/docs/BUILD-RUN.md rename to docs/BUILD-RUN.md diff --git a/libsql-server/docs/CONSISTENCY_MODEL.md b/docs/CONSISTENCY_MODEL.md similarity index 100% rename from libsql-server/docs/CONSISTENCY_MODEL.md rename to docs/CONSISTENCY_MODEL.md diff --git a/libsql-server/docs/DESIGN.md b/docs/DESIGN.md similarity index 100% rename from libsql-server/docs/DESIGN.md rename to docs/DESIGN.md diff --git a/libsql-server/docs/DOCKER.md b/docs/DOCKER.md similarity index 100% rename from libsql-server/docs/DOCKER.md rename to docs/DOCKER.md diff --git a/libsql-server/docs/HRANA_1_SPEC.md b/docs/HRANA_1_SPEC.md similarity index 100% rename from libsql-server/docs/HRANA_1_SPEC.md rename to docs/HRANA_1_SPEC.md diff --git a/libsql-server/docs/HRANA_2_SPEC.md b/docs/HRANA_2_SPEC.md similarity index 100% rename from libsql-server/docs/HRANA_2_SPEC.md rename to docs/HRANA_2_SPEC.md diff --git a/libsql-server/docs/HRANA_3_SPEC.md b/docs/HRANA_3_SPEC.md similarity index 100% rename from libsql-server/docs/HRANA_3_SPEC.md rename to docs/HRANA_3_SPEC.md diff --git a/libsql-server/docs/HTTP_V1_SPEC.md b/docs/HTTP_V1_SPEC.md similarity index 100% rename from libsql-server/docs/HTTP_V1_SPEC.md rename to docs/HTTP_V1_SPEC.md diff --git a/libsql-server/docs/HTTP_V2_SPEC.md b/docs/HTTP_V2_SPEC.md similarity index 100% rename from libsql-server/docs/HTTP_V2_SPEC.md rename to docs/HTTP_V2_SPEC.md diff --git a/libsql-server/docs/USER_GUIDE.md b/docs/USER_GUIDE.md similarity index 100% rename from libsql-server/docs/USER_GUIDE.md rename to docs/USER_GUIDE.md diff --git a/libsql-server/docs/http_api.md b/docs/http_api.md similarity index 100% rename from libsql-server/docs/http_api.md rename to docs/http_api.md diff --git a/libsql-server/docs/sqld-overview.excalidraw b/docs/sqld-overview.excalidraw similarity index 100% rename from libsql-server/docs/sqld-overview.excalidraw rename to docs/sqld-overview.excalidraw diff --git a/libsql-server/docs/sqld-overview.png b/docs/sqld-overview.png similarity index 100% rename from libsql-server/docs/sqld-overview.png rename to docs/sqld-overview.png From bb9799231dc864b472ad10ff0a5518d3bd3cb5b1 Mon Sep 17 00:00:00 2001 From: Lucio Franco Date: Tue, 14 Nov 2023 10:28:35 -0500 Subject: [PATCH 2/2] docs: add client versions doc --- docs/client_version_metrics.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/client_version_metrics.md diff --git a/docs/client_version_metrics.md b/docs/client_version_metrics.md new file mode 100644 index 0000000000..f22e752830 --- /dev/null +++ b/docs/client_version_metrics.md @@ -0,0 +1,15 @@ +# Client verison metrics + +Currently, `sqld` supports clients passing their client version via a +`x-libsql-client-version` header. The value of this header should follow this +pattern: + +- Hrana/Remote clients should be `libsql-remote--` +- Embedded replica clients should be `libsql-rpc--` + + +`` should be a reference to the language, for example, +`rust`/`go`/`js`/`python`. + +`` should be a reference to either a semver version or a commit sha +(first 6 chars of the sha).