From c8b51b7ebe0b64d81c9342c89e5c928916beddbf Mon Sep 17 00:00:00 2001 From: Itai Smith Date: Mon, 16 Dec 2024 13:55:00 -0800 Subject: [PATCH] rename tabs --- docs/docs.trychroma.com/README.md | 2 +- .../components/markdoc/tabbed-code-block.tsx | 2 +- .../components/markdoc/tabbed-use-case-code-block.tsx | 2 +- .../components/markdoc/{markdoc-tabs.tsx => tabs.tsx} | 2 +- docs/docs.trychroma.com/markdoc/config.ts | 4 ++-- .../markdoc/content/docs/overview/getting-started.md | 8 ++++---- .../markdoc/content/docs/overview/telemetry.md | 4 ++-- .../markdoc/content/docs/run-chroma/client-server.md | 4 ++-- .../markdoc/content/docs/run-chroma/persistent-client.md | 4 ++-- .../content/integrations/embedding-models/cohere.md | 4 ++-- .../integrations/embedding-models/google-gemini.md | 4 ++-- .../content/integrations/embedding-models/openai.md | 4 ++-- .../markdoc/content/production/administration/auth.md | 8 ++++---- .../production/chroma-server/client-server-mode.md | 4 ++-- .../markdoc/content/production/cloud-providers/aws.md | 4 ++-- .../markdoc/content/production/cloud-providers/azure.md | 4 ++-- .../markdoc/content/production/cloud-providers/gcp.md | 4 ++-- .../markdoc/content/production/containers/docker.md | 8 ++++---- 18 files changed, 38 insertions(+), 38 deletions(-) rename docs/docs.trychroma.com/components/markdoc/{markdoc-tabs.tsx => tabs.tsx} (97%) diff --git a/docs/docs.trychroma.com/README.md b/docs/docs.trychroma.com/README.md index e8a6ac1d73d8..846120bc35ea 100644 --- a/docs/docs.trychroma.com/README.md +++ b/docs/docs.trychroma.com/README.md @@ -28,7 +28,7 @@ It also incldues [Shadcn](https://ui.shadcn.com/) with [Tailwind](https://tailwi - Dark/Light Mode - Responsive - Global and Local state management with localstorage persistence -- MarkdocTabs +- Tabs - Code styling with Prism - Toasts diff --git a/docs/docs.trychroma.com/components/markdoc/tabbed-code-block.tsx b/docs/docs.trychroma.com/components/markdoc/tabbed-code-block.tsx index 5a4c11199596..2aa58fa5586d 100644 --- a/docs/docs.trychroma.com/components/markdoc/tabbed-code-block.tsx +++ b/docs/docs.trychroma.com/components/markdoc/tabbed-code-block.tsx @@ -4,7 +4,7 @@ import { TabsContent, TabsList } from "@/components/ui/tabs"; import { tabLabelStyle } from "@/components/markdoc/code-block-header"; import { capitalize, cn } from "@/lib/utils"; import CodeBlock from "@/components/markdoc/code-block"; -import { TabProps, TabsTrigger } from "@/components/markdoc/markdoc-tabs"; +import { TabProps, TabsTrigger } from "@/components/markdoc/tabs"; import CodeTabs from "@/components/markdoc/code-tab"; const TabbedCodeBlock: React.FC<{ diff --git a/docs/docs.trychroma.com/components/markdoc/tabbed-use-case-code-block.tsx b/docs/docs.trychroma.com/components/markdoc/tabbed-use-case-code-block.tsx index 87490ba6fdfb..446d8b6486ba 100644 --- a/docs/docs.trychroma.com/components/markdoc/tabbed-use-case-code-block.tsx +++ b/docs/docs.trychroma.com/components/markdoc/tabbed-use-case-code-block.tsx @@ -2,7 +2,7 @@ import React, { ReactElement } from "react"; import { tabLabelStyle } from "@/components/markdoc/code-block-header"; import { capitalize, cn } from "@/lib/utils"; import { Tabs, TabsContent, TabsList, TabsTrigger } from "@/components/ui/tabs"; -import { TabProps } from "@/components/markdoc/markdoc-tabs"; +import { TabProps } from "@/components/markdoc/tabs"; import CodeBlock from "@/components/markdoc/code-block"; import CopyButton from "@/components/markdoc/copy-button"; diff --git a/docs/docs.trychroma.com/components/markdoc/markdoc-tabs.tsx b/docs/docs.trychroma.com/components/markdoc/tabs.tsx similarity index 97% rename from docs/docs.trychroma.com/components/markdoc/markdoc-tabs.tsx rename to docs/docs.trychroma.com/components/markdoc/tabs.tsx index 32d794c421cb..593f5fa6bc6c 100644 --- a/docs/docs.trychroma.com/components/markdoc/markdoc-tabs.tsx +++ b/docs/docs.trychroma.com/components/markdoc/tabs.tsx @@ -49,7 +49,7 @@ const Tab: React.FC = ({ children }) => { return
{children}
; }; -export const MarkdocTabs: React.FC<{ children: ReactElement[] }> = ({ +export const Tabs: React.FC<{ children: ReactElement[] }> = ({ children, }) => { const { language } = useContext(AppContext); diff --git a/docs/docs.trychroma.com/markdoc/config.ts b/docs/docs.trychroma.com/markdoc/config.ts index acc0398b83a3..7eddc716ad89 100644 --- a/docs/docs.trychroma.com/markdoc/config.ts +++ b/docs/docs.trychroma.com/markdoc/config.ts @@ -3,7 +3,7 @@ import React from "react"; import InlineCode from "@/components/markdoc/inline-code"; import CodeBlock from "@/components/markdoc/code-block"; import TabbedUseCaseCodeBlock from "@/components/markdoc/tabbed-use-case-code-block"; -import Tab, { MarkdocTabs } from "@/components/markdoc/markdoc-tabs"; +import Tab, { Tabs } from "@/components/markdoc/tabs"; import { Table, TableHeader, @@ -117,7 +117,7 @@ const markdocConfig: MarkDocConfig = { TabbedCodeBlock, TabbedUseCaseCodeBlock, Tab, - Tabs: MarkdocTabs, + Tabs: Tabs, Table, TableHeader, TableBody, diff --git a/docs/docs.trychroma.com/markdoc/content/docs/overview/getting-started.md b/docs/docs.trychroma.com/markdoc/content/docs/overview/getting-started.md index 5ff535a65988..240e31bd1854 100644 --- a/docs/docs.trychroma.com/markdoc/content/docs/overview/getting-started.md +++ b/docs/docs.trychroma.com/markdoc/content/docs/overview/getting-started.md @@ -13,7 +13,7 @@ Chroma is an AI-native open-source vector database. It comes with everything you ### 1. Install -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -55,11 +55,11 @@ pip install chromadb {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} ### 2. Create a Chroma Client -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} ```python @@ -110,7 +110,7 @@ const client = new ChromaClient(); {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} ### 3. Create a collection diff --git a/docs/docs.trychroma.com/markdoc/content/docs/overview/telemetry.md b/docs/docs.trychroma.com/markdoc/content/docs/overview/telemetry.md index c69cfae9d53a..b7f7e12d1b35 100644 --- a/docs/docs.trychroma.com/markdoc/content/docs/overview/telemetry.md +++ b/docs/docs.trychroma.com/markdoc/content/docs/overview/telemetry.md @@ -12,7 +12,7 @@ If you prefer to opt out of telemetry, you can do this in two ways. #### In Client Code -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -33,7 +33,7 @@ Disable telemetry on you Chroma server (see next section). {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} #### In Chroma's Backend Using Environment Variables diff --git a/docs/docs.trychroma.com/markdoc/content/docs/run-chroma/client-server.md b/docs/docs.trychroma.com/markdoc/content/docs/run-chroma/client-server.md index b13d55aaff39..a7bb3d777380 100644 --- a/docs/docs.trychroma.com/markdoc/content/docs/run-chroma/client-server.md +++ b/docs/docs.trychroma.com/markdoc/content/docs/run-chroma/client-server.md @@ -8,7 +8,7 @@ To start the Chroma server, run the following command: chroma run --path /db_path ``` -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -56,4 +56,4 @@ const client = new ChromaClient(); {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} diff --git a/docs/docs.trychroma.com/markdoc/content/docs/run-chroma/persistent-client.md b/docs/docs.trychroma.com/markdoc/content/docs/run-chroma/persistent-client.md index 109b021c248f..443b717a4067 100644 --- a/docs/docs.trychroma.com/markdoc/content/docs/run-chroma/persistent-client.md +++ b/docs/docs.trychroma.com/markdoc/content/docs/run-chroma/persistent-client.md @@ -1,6 +1,6 @@ # Persistent Client -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -55,7 +55,7 @@ See [Running Chroma in client-server mode](../client-server-mode) for more. {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} The client object has a few useful convenience methods. diff --git a/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/cohere.md b/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/cohere.md index f177d674c2fd..2adbf9fa7184 100644 --- a/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/cohere.md +++ b/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/cohere.md @@ -7,7 +7,7 @@ name: 'Cohere' Chroma also provides a convenient wrapper around Cohere's embedding API. This embedding function runs remotely on Cohere’s servers, and requires an API key. You can get an API key by signing up for an account at [Cohere](https://dashboard.cohere.ai/welcome/register). -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} This embedding function relies on the `cohere` python package, which you can install with `pip install cohere`. @@ -37,7 +37,7 @@ const collectionGet = await client.getCollection({name:"name", embeddingFunction {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} You can pass in an optional `model_name` argument, which lets you choose which Cohere embeddings model to use. By default, Chroma uses `large` model. You can see the available models under `Get embeddings` section [here](https://docs.cohere.ai/reference/embed). diff --git a/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/google-gemini.md b/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/google-gemini.md index da73103ab89b..68fda0998337 100644 --- a/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/google-gemini.md +++ b/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/google-gemini.md @@ -9,7 +9,7 @@ Chroma provides a convenient wrapper around Google's Generative AI embedding API You can get an API key by signing up for an account at [Google MakerSuite](https://makersuite.google.com/). -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -64,4 +64,4 @@ For more info - please visit the [official Google JS docs](https://ai.google.dev {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} diff --git a/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/openai.md b/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/openai.md index 183d0e618aff..e119af989ac4 100644 --- a/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/openai.md +++ b/docs/docs.trychroma.com/markdoc/content/integrations/embedding-models/openai.md @@ -17,7 +17,7 @@ The following OpenAI Embedding Models are supported: Visit OpenAI Embeddings [documentation](https://platform.openai.com/docs/guides/embeddings) for more information. {% /Banner %} -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -75,4 +75,4 @@ collection = await client.getCollection({ {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} diff --git a/docs/docs.trychroma.com/markdoc/content/production/administration/auth.md b/docs/docs.trychroma.com/markdoc/content/production/administration/auth.md index 00238e781632..07d1b31ab2d8 100644 --- a/docs/docs.trychroma.com/markdoc/content/production/administration/auth.md +++ b/docs/docs.trychroma.com/markdoc/content/production/administration/auth.md @@ -66,7 +66,7 @@ chroma run --path #### Client Set-Up -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -108,7 +108,7 @@ chromaClient.heartbeat() {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} We recommend setting the environment variable `CHROMA_CLIENT_AUTH_CREDENTIALS` instead of specifying the credentials in code. @@ -156,7 +156,7 @@ export CHROMA_SERVER_AUTHZ_PROVIDER="chromadb.auth.simple_rbac_authz.SimpleRBACA #### Client Set-Up -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -204,6 +204,6 @@ chromaClient.heartbeat() ``` {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} We recommend setting the environment variable `CHROMA_CLIENT_AUTH_CREDENTIALS` instead of specifying the token in code. Similarly, you can read the value of `CHROMA_AUTH_TOKEN_TRANSPORT_HEADER` in the client construction. \ No newline at end of file diff --git a/docs/docs.trychroma.com/markdoc/content/production/chroma-server/client-server-mode.md b/docs/docs.trychroma.com/markdoc/content/production/chroma-server/client-server-mode.md index 0d2795faa019..f4bab933f811 100644 --- a/docs/docs.trychroma.com/markdoc/content/production/chroma-server/client-server-mode.md +++ b/docs/docs.trychroma.com/markdoc/content/production/chroma-server/client-server-mode.md @@ -10,7 +10,7 @@ You can quickly experiment locally with Chroma in client/server mode by using ou chroma run --path /db_path ``` -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -57,4 +57,4 @@ const client = new ChromaClient(); {% /Tab %} -{% /MarkdocTabs %} \ No newline at end of file +{% /Tabs %} \ No newline at end of file diff --git a/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/aws.md b/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/aws.md index b6ba86d550b8..33ba16d11093 100644 --- a/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/aws.md +++ b/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/aws.md @@ -230,7 +230,7 @@ Add the `CHROMA_CLIENT_AUTH_CREDENTIALS` environment variable to your local envi export CHROMA_CLIENT_AUTH_CREDENTIALS="test-token" ``` -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -283,7 +283,7 @@ chromaClient.heartbeat() {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} ## Observability with AWS diff --git a/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/azure.md b/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/azure.md index 16c6665aff57..4d9bc766ffc2 100644 --- a/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/azure.md +++ b/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/azure.md @@ -189,7 +189,7 @@ Add the `CHROMA_CLIENT_AUTH_CREDENTIALS` environment variable to your local envi export CHROMA_CLIENT_AUTH_CREDENTIALS="test-token" ``` -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -242,7 +242,7 @@ chromaClient.heartbeat() {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} ## Observability with Azure diff --git a/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/gcp.md b/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/gcp.md index 70832936c520..92cbe226b0f0 100644 --- a/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/gcp.md +++ b/docs/docs.trychroma.com/markdoc/content/production/cloud-providers/gcp.md @@ -216,7 +216,7 @@ Add the `CHROMA_CLIENT_AUTH_CREDENTIALS` environment variable to your local envi export CHROMA_CLIENT_AUTH_CREDENTIALS="test-token" ``` -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -269,7 +269,7 @@ chromaClient.heartbeat() {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} ## Observability with GCP diff --git a/docs/docs.trychroma.com/markdoc/content/production/containers/docker.md b/docs/docs.trychroma.com/markdoc/content/production/containers/docker.md index ed3b657674b4..632f7c614fd6 100644 --- a/docs/docs.trychroma.com/markdoc/content/production/containers/docker.md +++ b/docs/docs.trychroma.com/markdoc/content/production/containers/docker.md @@ -118,7 +118,7 @@ In your client environment, set the `CHROMA_CLIENT_AUTH_CREDENTIALS` variable to export CHROMA_CLIENT_AUTH_CREDENTIALS="admin:admin" ``` -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -170,7 +170,7 @@ chromaClient.heartbeat() {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} ### Static API Token Authentication @@ -222,7 +222,7 @@ docker run --env-file ./.chroma_env -v :/chroma/ #### Client Set-Up -{% MarkdocTabs %} +{% Tabs %} {% Tab label="python" %} @@ -281,7 +281,7 @@ chromaClient.heartbeat() {% /Tab %} -{% /MarkdocTabs %} +{% /Tabs %} ## Observability with Docker