Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 115 additions & 0 deletions claude.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,110 @@
- Keep meta descriptions under 200 characters
- Keep meta titles under 60 characters

## Variables and snippets

### Variable import hierarchy
Variables follow a bottom-up import hierarchy:
- Snippets import their own variables directly
- Parent files MUST NOT duplicate variable imports that come from their snippets
- Only import variables in the main file if they are used directly in that file's content

### Checking for duplicate imports
Before finalizing any file migration, systematically check for duplicate variable imports:

1. **Read all imported snippets** to see what variables they import
2. **Compare with main file imports** to identify duplicates
3. **Remove duplicates from main file** - the snippet's variables are automatically available
4. **Verify all text** in the main file uses variables (not plain text)

Example workflow:
```
Main file uses: {CLOUD_LONG}, {SERVICE_LONG}
Snippet A imports: SERVICE_LONG, CONSOLE
Snippet B imports: CLOUD_LONG, VPC

Result: Main file should import NOTHING - all variables come from snippets
```

### Variable application checklist
For EVERY file migration, systematically check the vars.mdx file and apply ALL relevant variables:

**Core product variables:**
- CLOUD_LONG, SERVICE_LONG, SERVICE_SHORT, SELF_LONG, SELF_LONG_CAP
- CONSOLE, TIMESCALE_DB, PG, COMPANY

**Feature variables:**
- HYPERTABLE, HYPERTABLE_CAP (for "hypertable(s)" / "Hypertable(s)")
- HYPERCORE, HYPERCORE_CAP (for "hypercore" / "Hypercore")
- COLUMNSTORE, COLUMNSTORE_CAP (for "columnstore" / "Columnstore")
- ROWSTORE, ROWSTORE_CAP (for "rowstore" / "Rowstore")
- CAGG, CAGG_CAP (for "continuous aggregate(s)" / "Continuous aggregate(s)")
- MAT_HYPERTABLE, MAT_HYPERTABLE_CAP (for "materialized hypertable(s)")
- VPC (for "VPC")

**Pricing variables:**
- PRICING_PLAN, SCALE, ENTERPRISE

**Process:**
1. Read snippets/vars.mdx to see all available variables
2. Search the file content for terms that match variable values
3. Replace ALL occurrences with variables
4. Check that variables aren't imported twice (main file + snippets)

### Common patterns

**Pattern 1: Integration files**
```mdx
---
title: Integrate [Tool] with Tiger Cloud
sidebarTitle: [Tool]
description: [Tool description]
---

import IntegrationPrereqs from '/snippets/prerequisites/_integration-prereqs.mdx';
import OtherSnippet from '/snippets/path/_snippet.mdx';

[Tool][tool-link] does something with {SERVICE_LONG}.

## Prerequisites

<IntegrationPrereqs />

## Connect

Instructions with {CLOUD_LONG} and {SERVICE_SHORT} variables...

[tool-link]: https://example.com
```

Main file imports: NONE (if all variables come from snippets) or only those used directly in content

**Pattern 2: Snippet files**
```mdx
import { SERVICE_LONG, CONSOLE, VPC } from '/snippets/vars.mdx';

Content using {SERVICE_LONG}, {CONSOLE}, and {VPC}...
```

Snippets import only what they use directly

**Pattern 3: Nested snippets**
If snippet A imports snippet B:
- Snippet B imports its own variables
- Snippet A only imports variables it uses directly (not from B)
- Main file that imports snippet A gets variables from both A and B automatically

### Template literal syntax for Tab titles
When using variables in component props (like Tab titles), use template literal syntax:
```mdx
<Tab title={`${CLOUD_LONG}`}>
```

NOT:
```mdx
<Tab title="{CLOUD_LONG}">
```

## Git workflow
- NEVER use --no-verify when committing
- Ask how to handle uncommitted changes before starting
Expand All @@ -101,8 +205,19 @@

# Migration

## Critical migration requirements

**ALWAYS follow these steps for EVERY file migration:**

1. **Apply ALL relevant variables** - Systematically check snippets/vars.mdx and apply every applicable variable (see "Variables and snippets" section above)
2. **Check for duplicate imports** - Read all imported snippets to see what variables they import, then ensure the main file doesn't duplicate those imports
3. **Verify variable usage** - Ensure all content uses variables, not plain text for product names and features

## Migration steps

- Check the directory that the files are to move into
- Update all ${VARIABLES} to use the mintlify variables (reference snippets/vars.mdx for mappings)
- **CRITICAL**: After migration, check that variables are not imported twice (see "Variables and snippets" section)
- replace references to import since`<version>` with `<Icon icon="circle-play" iconType="duotone" />` Since `<version>` on its own line after the frontmatter, followed by a newline before content begins
- replace references to import deprecated`<version>` with `<Icon icon="circle-pause" iconType="duotone" />` Deprecated `<version>` on its own line after the frontmatter, followed by a newline before content begins
- replace references to import DeprecationNotice with `<Icon icon="circle-pause" iconType="duotone" />` Deprecated on its own line after the frontmatter, followed by a newline before content begins
Expand Down
4 changes: 2 additions & 2 deletions cloud/analyse-your-data-using-pgai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To start using {CLOUD_LONG} for your data:

<Install />

## Create a {SERVICE_LONG}
## Create a Tiger Cloud service

Now that you have an active {ACCOUNT_LONG}, you create and manage your {SERVICE_SHORT}s in {CONSOLE}. When you create a {SERVICE_SHORT}, you effectively create a blank {PG} database with additional {CLOUD_LONG} features available under your {PRICING_PLAN}. You then add or migrate your data into this database.

Expand All @@ -45,7 +45,7 @@ shows you how to connect.

</Procedure>

## Connect to your {SERVICE_SHORT}
## Connect to your service

To run queries and perform other operations, connect to your {SERVICE_SHORT}:

Expand Down
2 changes: 1 addition & 1 deletion cloud/tiger/get-started/get-started-with-tiger-cloud.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ ingest and query data faster while keeping the costs low.

<IntegrationPrereqs />

## Optimize time-series data in {HYPERTABLE}s with {HYPERCORE}
## Optimize time-series data in hypertables with hypercore

Time-series data represents the way a system, process, or behavior changes over time. {HYPERTABLE}_CAPs are {PG} tables
that help you improve insert and query performance by automatically partitioning your data by time. Each {HYPERTABLE}
Expand Down
12 changes: 6 additions & 6 deletions cloud/tiger/get-started/run-queries-from-console.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Available features are:
- **Cross-platform support**: work from [{CONSOLE}][portal-data-mode] or download the [desktop app][popsql-desktop] for macOS, Windows, and Linux.
- **Easy connection**: connect to {CLOUD_LONG}, {PG}, Redshift, Snowflake, BigQuery, MySQL, SQL Server, [and more][popsql-connections].

### Connect to your {SERVICE_LONG} in the data mode
### Connect to your Tiger Cloud service in the data mode

<Procedure>

Expand Down Expand Up @@ -89,11 +89,11 @@ If your {SERVICE_LONG} runs inside a {VPC}, do one of the following to enable ac
- Use an SSH tunnel: when you configure the connection in {POPSQL}, under `Advanced Options` enable `Connect over SSH`.
- Add {POPSQL}'s static IPs (`23.20.131.72, 54.211.234.135`) to your allowlist.

#### What happens if another member of my {PROJECT_LONG} uses the {DATA_MODE}?
#### What happens if another member of my Tiger Cloud project uses the data mode?

The number of {DATA_MODE} seats you are allocated depends on your [{PRICING_PLAN}][pricing-plan-features].

#### Will using the {DATA_MODE} affect the performance of my {SERVICE_LONG}?
#### Will using the data mode affect the performance of my Tiger Cloud service?

There are a few factors to consider:

Expand All @@ -111,7 +111,7 @@ If you'd like to prevent write operations such as insert or update, instead
of using the `tsdbadmin` user, create a read-only user for your {SERVICE_SHORT} and
use that in the {DATA_MODE}.

## {SQL_ASSISTANT_SHORT}
## SQL assistant

{SQL_ASSISTANT_SHORT} in [{CONSOLE}][portal-data-mode] is a chat-like interface that harnesses the power of AI to help you write, fix, and organize SQL faster and more accurately. Ask {SQL_ASSISTANT_SHORT} to change existing queries, write new ones from scratch, debug error messages, optimize for query performance, add comments, improve readability—and really, get answers to any questions you can think of.

Expand Down Expand Up @@ -192,7 +192,7 @@ manage {SQL_ASSISTANT_SHORT} settings under [`User name` > `Settings` > `SQL Ass
* **Sample data**: to give the LLM more context so you have better SQL suggestions, enable sample data sharing in the {SQL_ASSISTANT_SHORT} preferences.
* **Telemetry**: to improve {SQL_ASSISTANT_SHORT}, {COMPANY} collects telemetry and usage data, including prompts, responses, and query metadata.

## {OPS_MODE_CAP} {SQL_EDITOR}
## Ops mode SQL editor

{SQL_EDITOR} is an integrated secure UI that you use to run queries and see the results
for a {SERVICE_LONG}.
Expand Down Expand Up @@ -220,7 +220,7 @@ To use {SQL_EDITOR}:

</Procedure>

## Cloud {SQL_EDITOR} licenses
## Cloud SQL editor licenses

* **{SQL_EDITOR} in the {OPS_MODE}**: free for anyone with a [{ACCOUNT_LONG}][create-cloud-account].
* **Data mode**: the number of seats you are allocated depends on your [{PRICING_PLAN}][pricing-plan-features].
Expand Down
6 changes: 3 additions & 3 deletions cloud/tiger/understand/pricing-and-account-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ from initial development through to mission-critical enterprise applications.
or egress. There are no per-query fees, nor additional costs to read or write data. It's all completely
transparent, easily understood, and up to you.

### {CLOUD_LONG} free trial for the different price plans
### Tiger Cloud free trial for the different price plans

We offer new users a free, 30-day trial period of our {PERFORMANCE} plan with no credit card required.
During your trial, you can contact {CONTACT_SALES} to request information about, and access
Expand All @@ -84,7 +84,7 @@ resource usage and dashboards with performance insights. This allows you to clos
{CONSOLE}_SHORT also shows your month-to-date accrued charges, as well as a forecast of your expected
month-end bill. Your previous invoices are also available as PDFs for download.

### {COMPANY} support
### Tiger Data support

{COMPANY} runs a global support organization with Customer Satisfaction (CSAT) scores above 99%.
Support covers all timezones, and is fully staffed at weekend hours.
Expand Down Expand Up @@ -199,7 +199,7 @@ Your monthly price for compute and storage is computed similarly. For example, o
Some add-ons such as Elastic storage, Tiered storage, and Connection pooling may incur
additional charges. These charges are clearly marked in your billing snapshot in {CONSOLE}.

## Manage your {CLOUD_LONG} {PRICING_PLAN}
## Manage your Tiger Cloud pricing plan

You handle all details about your {CLOUD_LONG} project including updates to your {PRICING_PLAN},
payment methods, and add-ons in the [billing section in {CONSOLE}][cloud-billing]:
Expand Down
Loading