Skip to content
Merged
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
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feedback.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Feedback
description: Help us improve the TigerData documentation site by leaving your feedback
description: Help us improve the Tiger Data documentation site by leaving your feedback
title: "[Feedback]"
labels: ["documentation", "feedback", "community"]
body:
Expand All @@ -24,7 +24,7 @@ body:
- type: textarea
id: improvements
attributes:
label: How could we improve the TigerData documentation site?
label: How could we improve the Tiger Data documentation site?
placeholder: Send us your ideas!
- type: markdown
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/styles/templates/integration.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Integrate <third-party tool name> with Tiger
title: Integrate <third-party tool name> with Tiger Cloud
excerpt: SEO friendly explanation of why the user will do it
keywords: [<third-party tool name>]
---
Expand Down
6 changes: 3 additions & 3 deletions .github/styles/templates/procedure.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ This section shows you how to:

In order to \<a couple of words that sound like the title> you need the following:

* A [Tiger service][create-a-service]
* A [Tiger Cloud service][create-a-service]
* If you are using this template to write a new document, see some good doc examples:
* [Create your first Tiger service][create-a-service]
* [Secure your Tiger service with VPC Peering and AWS PrivateLink][secure-vpc-aws]
* [Create your first Tiger Cloud service][create-a-service]
* [Secure your Tiger Cloud service with VPC Peering and AWS PrivateLink][secure-vpc-aws]
* [Install TimescaleDB on Linux][install-linux]
* Read the [Google Developer Style Guide][gdsg]
* ...
Expand Down
28 changes: 14 additions & 14 deletions .helper-scripts/llms/generate_llms_full.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
#!/usr/bin/env python3
"""
TigerData Documentation LLM Generator
Tiger Data Documentation LLM Generator

This script generates a comprehensive llms-full.txt file for LLM training from
TigerData documentation. It processes all markdown files following the page-index.js
Tiger Data documentation. It processes all markdown files following the page-index.js
structure and applies various transformations.

Features:
Expand Down Expand Up @@ -44,7 +44,7 @@ def _load_comprehensive_variables(self) -> Dict[str, str]:
return {
# General Variables
'$PRODUCT_PREFIX': 'Tiger',
'$COMPANY': 'TigerData',
'$COMPANY': 'Tiger Data',
'$COMPANY_URL': 'https://www.tigerdata.com',
'$PG': 'Postgres',

Expand All @@ -56,34 +56,34 @@ def _load_comprehensive_variables(self) -> Dict[str, str]:
'$ENTERPRISE': 'Enterprise',

# Product Variables
'$CLOUD_LONG': 'Tiger',
'$CLOUD_SHORT': 'Tiger',
'$CLOUD_LONG': 'Tiger Cloud',
'$CLOUD_SHORT': 'Tiger Cloud',
'$LAKE_LONG': 'Tiger Lake',
'$LAKE_SHORT': 'Tiger Lake',
'$TIMESCALE_DB': 'TimescaleDB',
'$PRODUCTS_ALL': 'TigerData products',
'$PRODUCTS_CL_DB': 'Tiger and TimescaleDB',
'$PRODUCTS_ALL': 'Tiger Data products',
'$PRODUCTS_CL_DB': 'Tiger Cloud and TimescaleDB',
'$TDB_APACHE': 'TimescaleDB Apache 2 Edition',
'$TDB_COMMUNITY': 'TimescaleDB Community Edition',

# Service Variables
'$SERVICE_LONG': 'Tiger service',
'$SERVICE_LONG': 'Tiger Cloud service',
'$SERVICE_SHORT': 'service',
'$MST_LONG': 'Managed Service for TimescaleDB',
'$MST_SHORT': 'MST',
'$MST_SERVICE_SHORT': 'service',
'$MST_SERVICE_LONG': 'service',
'$MST_CONSOLE_SHORT': 'MST Console',
'$CONSOLE': 'Console',
'$CONSOLE_LONG': 'Tiger Console',
'$CONSOLE_LONG': 'Tiger Cloud Console',
'$CONSOLE_SHORT': 'Console',
'$SELF_LONG': 'self-hosted TimescaleDB',
'$SELF_SHORT': 'self-hosted TimescaleDB',

# Feature Variables
'$HYPERTABLE': 'hypertable',
'$HYPERTABLES': 'hypertables',
'$HYPERCORE': 'Hypercore',
'$HYPERCORE': 'hypercore',
'$COLUMNSTORE': 'columnstore',
'$ROWSTORE': 'rowstore',
'$CHUNK': 'chunk',
Expand Down Expand Up @@ -123,7 +123,7 @@ def _load_comprehensive_variables(self) -> Dict[str, str]:
'$DOCS': 'docs',

# Account & Project Variables
'$ACCOUNT_LONG': 'TigerData account',
'$ACCOUNT_LONG': 'Tiger Data account',
'$PROJECT_SHORT': 'project',
'$JOB': 'job',
'$SOURCE': 'source',
Expand All @@ -147,7 +147,7 @@ def _load_comprehensive_variables(self) -> Dict[str, str]:
'$MST_CONSOLE_LONG': 'MST Console',
'$POPSQL': 'PopSQL',
'$ACCOUNT_SHORT': 'account',
'$PROJECT_LONG': 'TigerData project',
'$PROJECT_LONG': 'Tiger Data project',
'$HA_REPLICA': 'high availability replica',
'$TIME_BUCKET': 'time_bucket',
'$BODY': 'body',
Expand Down Expand Up @@ -758,7 +758,7 @@ def should_exclude_file(self, file_path: Path) -> bool:

def generate_documentation(self) -> str:
"""Generate the complete documentation."""
print("Starting TigerData documentation generation...")
print("Starting Tiger Data documentation generation...")

# Get ordered sections from main page index
ordered_sections = self.parse_main_page_index()
Expand Down Expand Up @@ -819,7 +819,7 @@ def save_documentation(self, content: str, output_file: str = "llms-full.txt"):

def main():
"""Main function to generate the documentation."""
print("TigerData Documentation LLM Generator")
print("Tiger Data Documentation LLM Generator")
print("=" * 50)

# Create generator instance
Expand Down
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Contribute to TigerData documentation
# Contribute to Tiger Data documentation

TigerData documentation is open for contribution from all community members. The current source is in this repository.
Tiger Data documentation is open for contribution from all community members. The current source is in this repository.

This page explains the structure and language guidelines for contributing to TigerData documentation. See the [README][readme] for how to contribute.
This page explains the structure and language guidelines for contributing to Tiger Data documentation. See the [README][readme] for how to contribute.

## Language

Write in a clear, concise, and actionable manner. TigerData documentation uses the [Google Developer Documentation Style Guide][google-style] with the following exceptions:
Write in a clear, concise, and actionable manner. Tiger Data documentation uses the [Google Developer Documentation Style Guide][google-style] with the following exceptions:

- Do not capitalize the first word after a colon.
- Use code font (back ticks) for UI elements instead of semi-bold.
Expand All @@ -20,7 +20,7 @@ Each major doc section has a dedicated directory with `.md` files inside, repres
- A short intro describing the main subject of the page.
- A visual illustrating the main concept, if relevant.
- Paragraphs with descriptive headers, organizing the content into logical sections.
- Procedures to describe the sequence of steps to reach a certain goal. For example, create a Tiger service.
- Procedures to describe the sequence of steps to reach a certain goal. For example, create a Tiger Cloud service.
- Other visual aids, if necessary.
- Links to other relevant resources.

Expand Down Expand Up @@ -54,22 +54,22 @@ The navigation hierarchy of a doc section is governed by `page-index/page-index.

```js
{
title: "Tiger services",
title: "Tiger Cloud services",
href: "services",
excerpt: "About Tiger services",
excerpt: "About Tiger Cloud services",
children: [
{
title: "Services overview",
href: "service-overview",
excerpt: "Tiger services overview",
excerpt: "Tiger Cloud services overview",
},
{
title: "Service explorer",
href: "service-explorer",
excerpt: "Tiger services explorer",
excerpt: "Tiger Cloud services explorer",
},
{
title: "Troubleshooting Tiger services",
title: "Troubleshooting Tiger Cloud services",
href: "troubleshooting",
type: "placeholder",
},
Expand Down Expand Up @@ -100,7 +100,7 @@ live in the `_partials` top-level directory. To make a new partial, create a new

## Formatting

In addition to all the [regular Markdown formatting][markdown-syntax], the following elements are available for TigerData docs:
In addition to all the [regular Markdown formatting][markdown-syntax], the following elements are available for Tiger Data docs:

- Procedure blocks
- Highlight blocks
Expand All @@ -113,7 +113,7 @@ See [Formatting examples][formatting] for how to use them.

## Variables

TigerData documentation uses variables for its product names, features, and UI elements in Tiger Console with the following syntax: `$VARIABLE_NAME`. Variables do not work inside the following:
Tiger Data documentation uses variables for its product names, features, and UI elements in Tiger Cloud Console with the following syntax: `$VARIABLE_NAME`. Variables do not work inside the following:

- Front matter on each page
- HTML tables and tabs
Expand Down Expand Up @@ -145,8 +145,8 @@ To make a documentation page more visible and clear for Google:
- Summarize the contents of each paragraph in the first sentence of that paragraph.
- Include main page keywords into the meta tags, page title, first header, and intro. These are usually the names of features described in the page. For example, for a page dedicated to creating hypertables, you can use the keyword **hypertable** in the following way:

- Title: Create a hypertable in Tiger
- Description: Turn a regular $PG table into a hypertable in a few steps, using Tiger Console.
- Title: Create a hypertable in Tiger Cloud
- Description: Turn a regular Postgres table into a hypertable in a few steps, using Tiger Cloud Console.
- First header: Create a hypertable

## Docs for deprecated products
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,29 +2,29 @@
<picture align=center>
<source media="(prefers-color-scheme: dark)" srcset="https://assets.timescale.com/docs/images/tigerdata-gradient-white.svg">
<source media="(prefers-color-scheme: light)" srcset="https://assets.timescale.com/docs/images/tigerdata-gradient-black.svg">
<img alt="TigerData logo" >
<img alt="Tiger Data logo" >
</picture>
</div>

<div align=center>

<h3>Tiger is the modern Postgres data platform for all your applications. It enhances Postgres to handle time series, events, real-time analytics, and vector search—all in a single database alongside transactional workloads.
<h3>Tiger Cloud is the modern Postgres data platform for all your applications. It enhances Postgres to handle time series, events, real-time analytics, and vector search—all in a single database alongside transactional workloads.
</h3>

[![Docs](https://img.shields.io/badge/Read_the_TigerData_docs-black?style=for-the-badge&logo=readthedocs&logoColor=white)](https://docs.tigerdata.com/)
[![SLACK](https://img.shields.io/badge/Ask_the_TigerData_community-black?style=for-the-badge&logo=slack&logoColor=white)](https://timescaledb.slack.com/archives/C4GT3N90X)
[![Try Tiger for free](https://img.shields.io/badge/Try_Tiger_for_free-black?style=for-the-badge&logo=timescale&logoColor=white)](https://console.cloud.timescale.com/signup)
[![Try Tiger Cloud for free](https://img.shields.io/badge/Try_Tiger_for_free-black?style=for-the-badge&logo=timescale&logoColor=white)](https://console.cloud.timescale.com/signup)

</div>

This repository contains the current source for TigerData documentation available at https://docs.tigerdata.com/.
This repository contains the current source for Tiger Data documentation available at https://docs.tigerdata.com/.

We welcome contributions! You can contribute to TigerData documentation in the following ways:
We welcome contributions! You can contribute to Tiger Data documentation in the following ways:

- [Create an issue][docs-issues] in this repository and describe the proposed change. Our doc team takes care of it.
- Update the docs yourself and have your change reviewed and published by our doc team.

## Contribute to the TigerData docs
## Contribute to the Tiger Data docs

To make the contribution yourself:

Expand All @@ -45,9 +45,9 @@ To make the contribution yourself:

See the [Contributing guide](CONTRIBUTING.md) for style and language guidance.

## Learn about TigerData
## Learn about Tiger Data

TigerData is Postgres made powerful. To learn more about the company and its products, visit [tigerdata.com](https://www.tigerdata.com).
Tiger Data is Postgres made powerful. To learn more about the company and its products, visit [tigerdata.com](https://www.tigerdata.com).

[docs-issues]: https://github.com/timescale/docs/issues
[github-fork]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
Expand Down
5 changes: 5 additions & 0 deletions _partials/_billing-for-inactive-services.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Highlight type="important">

You are charged for all active $SERVICE_SHORTs in your account, even if you are not actively using them. To reduce costs, pause or delete your unused $SERVICE_SHORTs.

</Highlight>
5 changes: 4 additions & 1 deletion _partials/_cloud-connect-service.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import NotAvailableFreePlan from "versionContent/_partials/_not-available-in-free-plan.mdx";

<Procedure>

Expand All @@ -11,10 +12,12 @@

Connect using data mode or SQL editor in $CONSOLE, or psql in the command line:

<Tabs label="Connect to your Tiger service" persistKey="sql-editor">
<Tabs label="Connect to your Tiger Cloud service" persistKey="sql-editor">

<Tab title="Data mode in Console" label="data-mode">

<NotAvailableFreePlan />

<Procedure>

1. In $CONSOLE, toggle `Data`.
Expand Down
4 changes: 2 additions & 2 deletions _partials/_cloud-create-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<li>
<p>
Sign in to the{" "}
<a href="https://console.cloud.timescale.com/">Tiger Console</a> and click <code>Create service</code>.
<a href="https://console.cloud.timescale.com/">Tiger Cloud Console</a> and click <code>Create service</code>.
</p>
</li>
<li>
Expand All @@ -26,7 +26,7 @@
class="main-content__illustration"
width={1375} height={944}
src="https://assets.timescale.com/docs/images/tsc-create-service-demo.png"
alt="Create a new service in the Tiger Console"
alt="Create a new service in the Tiger Cloud Console"
/>
</li>
)}
Expand Down
22 changes: 13 additions & 9 deletions _partials/_cloud-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

You create a $ACCOUNT_LONG to manage your $SERVICE_SHORTs and data in a centralized and efficient manner in $CONSOLE. From there, you can create and delete $SERVICE_SHORTs, run queries, manage access and billing, integrate other services, contact support, and more.

<Tabs label="Create a Tiger account" persistKey="source-cloud">
<Tabs label="Create a Tiger Cloud account" persistKey="source-cloud">

<Tab title="Tiger" label="tiger-cloud">

Expand All @@ -16,11 +16,13 @@ To set up $CLOUD_LONG:

Open [Sign up for $CLOUD_LONG][timescale-signup] and add your details, then click `Start your free trial`. You receive a confirmation email in your inbox.

1. **In the confirmation email, click the link supplied and sign in to [$CONSOLE][tsc-portal]**
1. **Confirm your email address**

1. **Answer the requirements questions**
In the confirmation email, click the link supplied.

Your answers help us optimize $SERVICE_LONGs for your use cases.
1. **Select the [pricing plan][pricing-plans]**

You are now logged into $CONSOLE_LONG. You can change the pricing plan to better accommodate your growing needs on the [`Billing` page][console-billing].

</Procedure>

Expand All @@ -35,7 +37,7 @@ case, $CLOUD_LONG is a line item in your AWS invoice.

To set up $CLOUD_LONG via AWS:

1. **Open [AWS Marketplace][aws-marketplace] and search for `Tiger`**
1. **Open [AWS Marketplace][aws-marketplace] and search for `Tiger Cloud`**

You see two pricing options, [pay-as-you-go][aws-paygo] and [annual commit][aws-annual-commit].

Expand All @@ -51,13 +53,13 @@ To set up $CLOUD_LONG via AWS:

Add your details, then click `Start your free trial`. If you want to link an existing $ACCOUNT_LONG to AWS, log in with your existing credentials.

1. **In `Confirm AWS Marketplace connection`, click `Connect`**
1. **Select the [pricing plan][pricing-plans]**

Your $CLOUD_LONG and AWS accounts are now connected.
You are now logged into $CONSOLE_LONG. You can change the pricing plan later to better accommodate your growing needs on the [`Billing` page][console-billing].

1. **Answer the requirements questions**
1. **In `Confirm AWS Marketplace connection`, click `Connect`**

Your answers help us optimize $SERVICE_LONGs for your use cases.
Your $CLOUD_LONG and AWS accounts are now connected.

</Procedure>

Expand All @@ -71,3 +73,5 @@ To set up $CLOUD_LONG via AWS:
[aws-paygo]: https://aws.amazon.com/marketplace/pp/prodview-iestawpo5ihca?applicationId=AWSMPContessa&ref_=beagle&sr=0-1
[aws-annual-commit]: https://aws.amazon.com/marketplace/pp/prodview-ezxwlmjyr6x4u?applicationId=AWSMPContessa&ref_=beagle&sr=0-2
[timescale-signup]: https://console.cloud.timescale.com/signup
[console-billing]: https://console.cloud.timescale.com/dashboard/billing/plans
[pricing-plans]: /about/:currentVersion:/pricing-and-account-management/
6 changes: 3 additions & 3 deletions _partials/_cloud-intro-short.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
A $SERVICE_LONG is a single optimised $PG instance extended with innovations in the database engine such as
$TIMESCALE_DB, in a cloud infrastructure that delivers speed without compromise.
$TIMESCALE_DB, in a cloud infrastructure that delivers speed without sacrifice.

A $SERVICE_LONG is a radically faster $PG database for transactional, analytical, and agentic
workloads at scale.

It’s not a fork. It’s not a wrapper. It is $PG—extended with innovations in the database
engine and cloud infrastructure to deliver speed (10-1000x faster at scale) without compromise.
engine and cloud infrastructure to deliver speed (10-1000x faster at scale) without sacrifice.
A $SERVICE_LONG brings together the familiarity and reliability of $PG with the performance of
purpose-built engines.

$CLOUD_LONG is the fastest $PG cloud. It includes everything you need
to run $PG in a productionreliable, scalable, observable environment.
to run $PG in a production-reliable, scalable, observable environment.
Loading