Skip to content

Commit 9a8cdcf

Browse files
danciaclaradanciaclara
committed
formatting fixes
1 parent 21d259d commit 9a8cdcf

5 files changed

Lines changed: 42 additions & 46 deletions

File tree

‎docs/.vitepress/config.mts‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -276,9 +276,7 @@ export default withMermaid(
276276
text: "Plane AI",
277277
link: "/self-hosting/govern/plane-ai",
278278
collapsed: true,
279-
items: [
280-
{ text: "AWS OpenSearch embedding", link: "/self-hosting/govern/aws-opensearch-embedding" },
281-
],
279+
items: [{ text: "AWS OpenSearch embedding", link: "/self-hosting/govern/aws-opensearch-embedding" }],
282280
},
283281
{ text: "External secrets", link: "/self-hosting/govern/external-secrets" },
284282
{ text: "External reverse proxy", link: "/self-hosting/govern/reverse-proxy" },

‎docs/.vitepress/theme/style.css‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,8 @@ div[class*="language-"] > span.lang {
601601
/* Target the Sign in link using multiple class combinations */
602602
.VPNavBarMenuLink.VPLink[href*="sign-in"],
603603
a.VPLink.VPNavBarMenuLink[href*="sign-in"],
604-
.VPNavBarMenu .VPLink[href="https://app.plane.so/sign-in"] {
604+
.VPNavBarMenu .VPLink[href="https://app.plane.so/sign-in"]
605+
{
605606
background: #006399 !important;
606607
color: #ffffff !important;
607608
padding: 6px 14px !important;

‎docs/self-hosting/govern/aws-opensearch-embedding.md‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,7 @@ Make sure you have:
3838
{
3939
"Sid": "SecretManagerAccess",
4040
"Effect": "Allow",
41-
"Action": [
42-
"secretsmanager:GetSecretValue",
43-
"secretsmanager:DescribeSecret",
44-
"secretsmanager:ListSecrets"
45-
],
41+
"Action": ["secretsmanager:GetSecretValue", "secretsmanager:DescribeSecret", "secretsmanager:ListSecrets"],
4642
"Resource": "*"
4743
}
4844
]

‎docs/self-hosting/govern/environment-variables.md‎

Lines changed: 31 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -152,60 +152,59 @@ This is where you'll make all configuration changes. Remember to restart the ins
152152
| `OPENSEARCH_PASSWORD` | Authentication password | `your-secure-password` |
153153
| `OPENSEARCH_INDEX_PREFIX` | Prefix for all index names (useful for multi-tenant setups) | (empty) |
154154

155-
156155
### Plane AI
157156

158157
#### Plane AI replicas
159158

160159
To start Plane AI services, set each replica count to `1`:
161160

162-
| Variable | Description | Required |
163-
|----------|-------------|----------|
164-
| `PI_API_REPLICAS` | Plane AI API replica count | Yes |
165-
| `PI_BEAT_REPLICAS` | Plane AI Beat Worker replica count | Yes |
166-
| `PI_WORKER_REPLICAS` | Plane AI Worker replica count | Yes |
167-
| `PI_MIGRATOR_REPLICAS` | Plane AI Migrator replica count | Yes |
161+
| Variable | Description | Required |
162+
| ---------------------- | ---------------------------------- | -------- |
163+
| `PI_API_REPLICAS` | Plane AI API replica count | Yes |
164+
| `PI_BEAT_REPLICAS` | Plane AI Beat Worker replica count | Yes |
165+
| `PI_WORKER_REPLICAS` | Plane AI Worker replica count | Yes |
166+
| `PI_MIGRATOR_REPLICAS` | Plane AI Migrator replica count | Yes |
168167

169168
#### LLM provider API keys
170169

171170
Plane AI supports multiple LLM providers. Configure one or more by adding their API keys.
172171

173-
| Variable | Description | Required |
174-
|----------|-------------|----------|
175-
| `OPENAI_API_KEY` | API key for OpenAI models | Optional |
176-
| `CLAUDE_API_KEY` | API key for Anthropic models | Optional |
177-
| `GROQ_API_KEY` | API key for speech-to-text features | Optional |
178-
| `CUSTOM_LLM_ENABLED` | Set to `true` to use a custom LLM with an OpenAI-compatible API | Optional |
179-
| `CUSTOM_LLM_MODEL_KEY` | Identifier key for the custom model | Optional |
180-
| `CUSTOM_LLM_BASE_URL` | Base URL of the custom model's OpenAI-compatible endpoint | Optional |
181-
| `CUSTOM_LLM_API_KEY` | API key for the custom endpoint | Optional |
182-
| `CUSTOM_LLM_NAME` | Display name for the custom model | Optional |
183-
| `CUSTOM_LLM_DESCRIPTION` | Description of the custom model | Optional |
184-
| `CUSTOM_LLM_MAX_TOKENS` | Maximum token limit for the custom model | Optional |
172+
| Variable | Description | Required |
173+
| ------------------------ | --------------------------------------------------------------- | -------- |
174+
| `OPENAI_API_KEY` | API key for OpenAI models | Optional |
175+
| `CLAUDE_API_KEY` | API key for Anthropic models | Optional |
176+
| `GROQ_API_KEY` | API key for speech-to-text features | Optional |
177+
| `CUSTOM_LLM_ENABLED` | Set to `true` to use a custom LLM with an OpenAI-compatible API | Optional |
178+
| `CUSTOM_LLM_MODEL_KEY` | Identifier key for the custom model | Optional |
179+
| `CUSTOM_LLM_BASE_URL` | Base URL of the custom model's OpenAI-compatible endpoint | Optional |
180+
| `CUSTOM_LLM_API_KEY` | API key for the custom endpoint | Optional |
181+
| `CUSTOM_LLM_NAME` | Display name for the custom model | Optional |
182+
| `CUSTOM_LLM_DESCRIPTION` | Description of the custom model | Optional |
183+
| `CUSTOM_LLM_MAX_TOKENS` | Maximum token limit for the custom model | Optional |
185184

186185
#### Provider base URLs
187186

188187
Use these when routing requests through self-hosted gateways, proxies, or compatible third-party endpoints.
189188

190-
| Variable | Description | Default |
191-
|----------|-------------|---------|
192-
| `OPENAI_BASE_URL` | Custom base URL for OpenAI-compatible APIs | OpenAI |
189+
| Variable | Description | Default |
190+
| ----------------- | ------------------------------------------ | --------- |
191+
| `OPENAI_BASE_URL` | Custom base URL for OpenAI-compatible APIs | OpenAI |
193192
| `CLAUDE_BASE_URL` | Custom base URL for Claude-compatible APIs | Anthropic |
194-
| `COHERE_BASE_URL` | Custom base URL for Cohere APIs | Cohere |
195-
| `GROQ_BASE_URL` | Custom base URL for Groq APIs | Groq |
193+
| `COHERE_BASE_URL` | Custom base URL for Cohere APIs | Cohere |
194+
| `GROQ_BASE_URL` | Custom base URL for Groq APIs | Groq |
196195

197196
#### Embedding model configuration
198197

199198
These settings are required for semantic search and Plane AI Chat. Configure one of the following options.
200199

201-
| Variable | Description | Required |
202-
|----------|-------------|----------|
203-
| `EMBEDDING_MODEL_ID` | ID of an existing embedding model deployed in OpenSearch (works with both self-hosted and AWS OpenSearch) | Conditional |
204-
| `EMBEDDING_MODEL` | Embedding model to automatically deploy (e.g., `cohere/embed-v4.0`, `openai/text-embedding-3-small`, `bedrock/amazon.titan-embed-text-v1`). Self-hosted OpenSearch only. | Conditional |
205-
| `COHERE_API_KEY` | API key for Cohere embedding models | Conditional |
206-
| `BR_AWS_ACCESS_KEY_ID` | AWS access key ID for Bedrock Titan embedding | Conditional |
207-
| `BR_AWS_SECRET_ACCESS_KEY` | AWS secret access key for Bedrock Titan embedding | Conditional |
208-
| `BR_AWS_REGION` | AWS region for Bedrock Titan embedding | Conditional |
200+
| Variable | Description | Required |
201+
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
202+
| `EMBEDDING_MODEL_ID` | ID of an existing embedding model deployed in OpenSearch (works with both self-hosted and AWS OpenSearch) | Conditional |
203+
| `EMBEDDING_MODEL` | Embedding model to automatically deploy (e.g., `cohere/embed-v4.0`, `openai/text-embedding-3-small`, `bedrock/amazon.titan-embed-text-v1`). Self-hosted OpenSearch only. | Conditional |
204+
| `COHERE_API_KEY` | API key for Cohere embedding models | Conditional |
205+
| `BR_AWS_ACCESS_KEY_ID` | AWS access key ID for Bedrock Titan embedding | Conditional |
206+
| `BR_AWS_SECRET_ACCESS_KEY` | AWS secret access key for Bedrock Titan embedding | Conditional |
207+
| `BR_AWS_REGION` | AWS region for Bedrock Titan embedding | Conditional |
209208

210209
For setup instructions, supported models, and IAM permissions, see [Enable Plane AI](/self-hosting/govern/plane-ai).
211210

‎docs/self-hosting/govern/plane-ai.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,15 @@ You'll need:
2525
#### OpenAI
2626

2727
Supported models:
28+
2829
- GPT-5
2930
- GPT-4.1
3031
- GPT-5.2
3132

3233
#### Anthropic
3334

3435
Supported models:
36+
3537
- Claude Sonnet 4.0
3638
- Claude Sonnet 4.5
3739
- Claude Sonnet 4.6
@@ -50,11 +52,11 @@ For reliable performance across all Plane AI features, use a custom model with a
5052

5153
Embedding models power semantic search. Plane AI supports:
5254

53-
| Provider | Supported models |
54-
|----------|-----------------|
55-
| **Cohere** | `cohere/embed-v4.0` |
56-
| **OpenAI** | `openai/text-embedding-ada-002`, `openai/text-embedding-3-small` |
57-
| **AWS Bedrock (Titan)** | `bedrock/amazon.titan-embed-text-v1` |
55+
| Provider | Supported models |
56+
| ----------------------- | ---------------------------------------------------------------- |
57+
| **Cohere** | `cohere/embed-v4.0` |
58+
| **OpenAI** | `openai/text-embedding-ada-002`, `openai/text-embedding-3-small` |
59+
| **AWS Bedrock (Titan)** | `bedrock/amazon.titan-embed-text-v1` |
5860

5961
## Enable Plane AI services
6062

0 commit comments

Comments
 (0)