From 682946bdbc5ffd6eea8c078de9be7298c2c98c26 Mon Sep 17 00:00:00 2001 From: Anush008 Date: Wed, 20 Nov 2024 23:14:39 +0530 Subject: [PATCH] docs: Re-organise API & SDKs, Web UI entries in the sidebar Signed-off-by: Anush008 --- .../content/documentation/fastembed/_index.md | 2 +- .../{interfaces/_index.md => interfaces.md} | 20 ++++++++----------- .../documentation/interfaces/api-reference.md | 7 ------- .../content/documentation/quickstart.md | 2 +- .../documentation/{interfaces => }/web-ui.md | 4 +++- 5 files changed, 13 insertions(+), 22 deletions(-) rename qdrant-landing/content/documentation/{interfaces/_index.md => interfaces.md} (95%) delete mode 100644 qdrant-landing/content/documentation/interfaces/api-reference.md rename qdrant-landing/content/documentation/{interfaces => }/web-ui.md (95%) diff --git a/qdrant-landing/content/documentation/fastembed/_index.md b/qdrant-landing/content/documentation/fastembed/_index.md index 6d4cd9230..2e7f6009b 100644 --- a/qdrant-landing/content/documentation/fastembed/_index.md +++ b/qdrant-landing/content/documentation/fastembed/_index.md @@ -1,6 +1,6 @@ --- title: "FastEmbed" -weight: 6 +weight: 7 partition: qdrant --- diff --git a/qdrant-landing/content/documentation/interfaces/_index.md b/qdrant-landing/content/documentation/interfaces.md similarity index 95% rename from qdrant-landing/content/documentation/interfaces/_index.md rename to qdrant-landing/content/documentation/interfaces.md index 2c8ce34e3..4db47a8a5 100644 --- a/qdrant-landing/content/documentation/interfaces/_index.md +++ b/qdrant-landing/content/documentation/interfaces.md @@ -1,20 +1,20 @@ --- title: API & SDKs -weight: 6 +weight: 5 partition: qdrant -aliases: - - /documentation/interfaces/ + --- # Interfaces -Qdrant supports these "official" clients. +Qdrant supports these "official" clients. -> **Note:** If you are using a language that is not listed here, you can use the REST API directly or generate a client for your language +> **Note:** If you are using a language that is not listed here, you can use the REST API directly or generate a client for your language using [OpenAPI](https://github.com/qdrant/qdrant/blob/master/docs/redoc/master/openapi.json) -or [protobuf](https://github.com/qdrant/qdrant/tree/master/lib/api/src/grpc/proto) definitions. +or [protobuf](https://github.com/qdrant/qdrant/tree/master/lib/api/src/grpc/proto) definitions. ## Client Libraries + ||Client Repository|Installation|Version| |-|-|-|-| |[![python](/docs/misc/python.webp)](https://python-client.qdrant.tech/)|**[Python](https://github.com/qdrant/qdrant-client)** + **[(Client Docs)](https://python-client.qdrant.tech/)**|`pip install qdrant-client[fastembed]`|[Latest Release](https://github.com/qdrant/qdrant-client/releases)| @@ -24,7 +24,6 @@ or [protobuf](https://github.com/qdrant/qdrant/tree/master/lib/api/src/grpc/prot |![.net](/docs/misc/dotnet.webp)|**[.NET](https://github.com/qdrant/qdrant-dotnet)**|`dotnet add package Qdrant.Client`|[Latest Release](https://github.com/qdrant/qdrant-dotnet/releases)| |![java](/docs/misc/java.webp)|**[Java](https://github.com/qdrant/java-client)**|[Available on Maven Central](https://central.sonatype.com/artifact/io.qdrant/client)|[Latest Release](https://github.com/qdrant/java-client/releases)| - ## API Reference All interaction with Qdrant takes place via the REST API. We recommend using REST API if you are using Qdrant for the first time or if you are working on a prototype. @@ -44,8 +43,9 @@ As per the [configuration file](https://github.com/qdrant/qdrant/blob/master/con service: grpc_port: 6334 ``` + - + Running the service inside of Docker will look like this: ```bash @@ -55,7 +55,3 @@ docker run -p 6333:6333 -p 6334:6334 \ ``` **When to use gRPC:** The choice between gRPC and the REST API is a trade-off between convenience and speed. gRPC is a binary protocol and can be more challenging to debug. We recommend using gRPC if you are already familiar with Qdrant and are trying to optimize the performance of your application. - - - - diff --git a/qdrant-landing/content/documentation/interfaces/api-reference.md b/qdrant-landing/content/documentation/interfaces/api-reference.md deleted file mode 100644 index 6ee8fc6b4..000000000 --- a/qdrant-landing/content/documentation/interfaces/api-reference.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: API Reference -weight: 1 -type: external-link -external_url: https://api.qdrant.tech/api-reference -sitemapExclude: True ---- \ No newline at end of file diff --git a/qdrant-landing/content/documentation/quickstart.md b/qdrant-landing/content/documentation/quickstart.md index dc9c103f5..7875e85bc 100644 --- a/qdrant-landing/content/documentation/quickstart.md +++ b/qdrant-landing/content/documentation/quickstart.md @@ -1,6 +1,6 @@ --- title: Local Quickstart -weight: 5 +weight: 4 partition: qdrant aliases: - quick_start diff --git a/qdrant-landing/content/documentation/interfaces/web-ui.md b/qdrant-landing/content/documentation/web-ui.md similarity index 95% rename from qdrant-landing/content/documentation/interfaces/web-ui.md rename to qdrant-landing/content/documentation/web-ui.md index e69d301ea..598154eb6 100644 --- a/qdrant-landing/content/documentation/interfaces/web-ui.md +++ b/qdrant-landing/content/documentation/web-ui.md @@ -1,8 +1,10 @@ --- title: Qdrant Web UI -weight: 2 +weight: 6 +partition: qdrant aliases: - /documentation/web-ui/ + - /documentation/interfaces/web-ui/ --- # Qdrant Web UI