Skip to content

Commit f4a0de9

Browse files
committed
Merge branch 'milestone-28-azure-cloud' of github.com:timescale/docs into 498-rework-create-a-tiger-cloud-service-with-a-dedicated-azure-tab
# Conflicts: # _partials/_cloud-intro.md # getting-started/services.md
2 parents a15fe1f + 18ba2bf commit f4a0de9

File tree

179 files changed

+3706
-701
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

179 files changed

+3706
-701
lines changed

.github/ISSUE_TEMPLATE/feedback.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Feedback
2-
description: Help us improve the TigerData documentation site by leaving your feedback
2+
description: Help us improve the Tiger Data documentation site by leaving your feedback
33
title: "[Feedback]"
44
labels: ["documentation", "feedback", "community"]
55
body:
@@ -24,7 +24,7 @@ body:
2424
- type: textarea
2525
id: improvements
2626
attributes:
27-
label: How could we improve the TigerData documentation site?
27+
label: How could we improve the Tiger Data documentation site?
2828
placeholder: Send us your ideas!
2929
- type: markdown
3030
attributes:

.github/styles/templates/integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Integrate <third-party tool name> with Tiger
2+
title: Integrate <third-party tool name> with Tiger Cloud
33
excerpt: SEO friendly explanation of why the user will do it
44
keywords: [<third-party tool name>]
55
---

.github/styles/templates/procedure.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ This section shows you how to:
3333

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

36-
* A [Tiger service][create-a-service]
36+
* A [Tiger Cloud service][create-a-service]
3737
* If you are using this template to write a new document, see some good doc examples:
38-
* [Create your first Tiger service][create-a-service]
39-
* [Secure your Tiger service with VPC Peering and AWS PrivateLink][secure-vpc-aws]
38+
* [Create your first Tiger Cloud service][create-a-service]
39+
* [Secure your Tiger Cloud service with VPC Peering and AWS PrivateLink][secure-vpc-aws]
4040
* [Install TimescaleDB on Linux][install-linux]
4141
* Read the [Google Developer Style Guide][gdsg]
4242
* ...

.helper-scripts/llms/generate_llms_full.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
#!/usr/bin/env python3
22
"""
3-
TigerData Documentation LLM Generator
3+
Tiger Data Documentation LLM Generator
44
55
This script generates a comprehensive llms-full.txt file for LLM training from
6-
TigerData documentation. It processes all markdown files following the page-index.js
6+
Tiger Data documentation. It processes all markdown files following the page-index.js
77
structure and applies various transformations.
88
99
Features:
@@ -44,7 +44,7 @@ def _load_comprehensive_variables(self) -> Dict[str, str]:
4444
return {
4545
# General Variables
4646
'$PRODUCT_PREFIX': 'Tiger',
47-
'$COMPANY': 'TigerData',
47+
'$COMPANY': 'Tiger Data',
4848
'$COMPANY_URL': 'https://www.tigerdata.com',
4949
'$PG': 'Postgres',
5050

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

5858
# Product Variables
59-
'$CLOUD_LONG': 'Tiger',
60-
'$CLOUD_SHORT': 'Tiger',
59+
'$CLOUD_LONG': 'Tiger Cloud',
60+
'$CLOUD_SHORT': 'Tiger Cloud',
6161
'$LAKE_LONG': 'Tiger Lake',
6262
'$LAKE_SHORT': 'Tiger Lake',
6363
'$TIMESCALE_DB': 'TimescaleDB',
64-
'$PRODUCTS_ALL': 'TigerData products',
65-
'$PRODUCTS_CL_DB': 'Tiger and TimescaleDB',
64+
'$PRODUCTS_ALL': 'Tiger Data products',
65+
'$PRODUCTS_CL_DB': 'Tiger Cloud and TimescaleDB',
6666
'$TDB_APACHE': 'TimescaleDB Apache 2 Edition',
6767
'$TDB_COMMUNITY': 'TimescaleDB Community Edition',
6868

6969
# Service Variables
70-
'$SERVICE_LONG': 'Tiger service',
70+
'$SERVICE_LONG': 'Tiger Cloud service',
7171
'$SERVICE_SHORT': 'service',
7272
'$MST_LONG': 'Managed Service for TimescaleDB',
7373
'$MST_SHORT': 'MST',
7474
'$MST_SERVICE_SHORT': 'service',
7575
'$MST_SERVICE_LONG': 'service',
7676
'$MST_CONSOLE_SHORT': 'MST Console',
7777
'$CONSOLE': 'Console',
78-
'$CONSOLE_LONG': 'Tiger Console',
78+
'$CONSOLE_LONG': 'Tiger Cloud Console',
7979
'$CONSOLE_SHORT': 'Console',
8080
'$SELF_LONG': 'self-hosted TimescaleDB',
8181
'$SELF_SHORT': 'self-hosted TimescaleDB',
8282

8383
# Feature Variables
8484
'$HYPERTABLE': 'hypertable',
8585
'$HYPERTABLES': 'hypertables',
86-
'$HYPERCORE': 'Hypercore',
86+
'$HYPERCORE': 'hypercore',
8787
'$COLUMNSTORE': 'columnstore',
8888
'$ROWSTORE': 'rowstore',
8989
'$CHUNK': 'chunk',
@@ -123,7 +123,7 @@ def _load_comprehensive_variables(self) -> Dict[str, str]:
123123
'$DOCS': 'docs',
124124

125125
# Account & Project Variables
126-
'$ACCOUNT_LONG': 'TigerData account',
126+
'$ACCOUNT_LONG': 'Tiger Data account',
127127
'$PROJECT_SHORT': 'project',
128128
'$JOB': 'job',
129129
'$SOURCE': 'source',
@@ -147,7 +147,7 @@ def _load_comprehensive_variables(self) -> Dict[str, str]:
147147
'$MST_CONSOLE_LONG': 'MST Console',
148148
'$POPSQL': 'PopSQL',
149149
'$ACCOUNT_SHORT': 'account',
150-
'$PROJECT_LONG': 'TigerData project',
150+
'$PROJECT_LONG': 'Tiger Data project',
151151
'$HA_REPLICA': 'high availability replica',
152152
'$TIME_BUCKET': 'time_bucket',
153153
'$BODY': 'body',
@@ -758,7 +758,7 @@ def should_exclude_file(self, file_path: Path) -> bool:
758758

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

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

820820
def main():
821821
"""Main function to generate the documentation."""
822-
print("TigerData Documentation LLM Generator")
822+
print("Tiger Data Documentation LLM Generator")
823823
print("=" * 50)
824824

825825
# Create generator instance

CONTRIBUTING.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Contribute to TigerData documentation
1+
# Contribute to Tiger Data documentation
22

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

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

77
## Language
88

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

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

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

5555
```js
5656
{
57-
title: "Tiger services",
57+
title: "Tiger Cloud services",
5858
href: "services",
59-
excerpt: "About Tiger services",
59+
excerpt: "About Tiger Cloud services",
6060
children: [
6161
{
6262
title: "Services overview",
6363
href: "service-overview",
64-
excerpt: "Tiger services overview",
64+
excerpt: "Tiger Cloud services overview",
6565
},
6666
{
6767
title: "Service explorer",
6868
href: "service-explorer",
69-
excerpt: "Tiger services explorer",
69+
excerpt: "Tiger Cloud services explorer",
7070
},
7171
{
72-
title: "Troubleshooting Tiger services",
72+
title: "Troubleshooting Tiger Cloud services",
7373
href: "troubleshooting",
7474
type: "placeholder",
7575
},
@@ -100,7 +100,7 @@ live in the `_partials` top-level directory. To make a new partial, create a new
100100

101101
## Formatting
102102

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

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

114114
## Variables
115115

116-
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:
116+
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:
117117

118118
- Front matter on each page
119119
- HTML tables and tabs
@@ -145,8 +145,8 @@ To make a documentation page more visible and clear for Google:
145145
- Summarize the contents of each paragraph in the first sentence of that paragraph.
146146
- 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:
147147

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

152152
## Docs for deprecated products

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,29 @@
22
<picture align=center>
33
<source media="(prefers-color-scheme: dark)" srcset="https://assets.timescale.com/docs/images/tigerdata-gradient-white.svg">
44
<source media="(prefers-color-scheme: light)" srcset="https://assets.timescale.com/docs/images/tigerdata-gradient-black.svg">
5-
<img alt="TigerData logo" >
5+
<img alt="Tiger Data logo" >
66
</picture>
77
</div>
88

99
<div align=center>
1010

11-
<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.
11+
<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.
1212
</h3>
1313

1414
[![Docs](https://img.shields.io/badge/Read_the_TigerData_docs-black?style=for-the-badge&logo=readthedocs&logoColor=white)](https://docs.tigerdata.com/)
1515
[![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)
16-
[![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)
16+
[![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)
1717

1818
</div>
1919

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

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

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

27-
## Contribute to the TigerData docs
27+
## Contribute to the Tiger Data docs
2828

2929
To make the contribution yourself:
3030

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

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

48-
## Learn about TigerData
48+
## Learn about Tiger Data
4949

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

5252
[docs-issues]: https://github.com/timescale/docs/issues
5353
[github-fork]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<Highlight type="important">
2+
3+
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.
4+
5+
</Highlight>

_partials/_cloud-connect-service.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import NotAvailableFreePlan from "versionContent/_partials/_not-available-in-free-plan.mdx";
12

23
<Procedure>
34

@@ -11,10 +12,12 @@
1112

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

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

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

19+
<NotAvailableFreePlan />
20+
1821
<Procedure>
1922

2023
1. In $CONSOLE, toggle `Data`.

_partials/_cloud-create-service.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<li>
77
<p>
88
Sign in to the{" "}
9-
<a href="https://console.cloud.timescale.com/">Tiger Console</a> and click <code>Create service</code>.
9+
<a href="https://console.cloud.timescale.com/">Tiger Cloud Console</a> and click <code>Create service</code>.
1010
</p>
1111
</li>
1212
<li>
@@ -26,7 +26,7 @@
2626
class="main-content__illustration"
2727
width={1375} height={944}
2828
src="https://assets.timescale.com/docs/images/tsc-create-service-demo.png"
29-
alt="Create a new service in the Tiger Console"
29+
alt="Create a new service in the Tiger Cloud Console"
3030
/>
3131
</li>
3232
)}

_partials/_cloud-installation.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
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.
44

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

7-
<Tab title="Tiger" label="tiger-cloud">
7+
<Tab title="Tiger Cloud" label="tiger-cloud">
88

99
You create a standalone account to manage $CLOUD_LONG as a separate unit in your infrastructure, which includes separate billing and invoicing.
1010

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

1717
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.
1818

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

21-
1. **Answer the requirements questions**
21+
In the confirmation email, click the link supplied.
2222

23-
Your answers help us optimize $SERVICE_LONGs for your use cases.
23+
1. **Select the [pricing plan][pricing-plans]**
24+
25+
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].
2426

2527
</Procedure>
2628

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

3638
To set up $CLOUD_LONG via AWS:
3739

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

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

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

5254
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.
5355

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

56-
Your $CLOUD_LONG and AWS accounts are now connected.
58+
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].
5759

58-
1. **Answer the requirements questions**
60+
1. **In `Confirm AWS Marketplace connection`, click `Connect`**
5961

60-
Your answers help us optimize $SERVICE_LONGs for your use cases.
62+
Your $CLOUD_LONG and AWS accounts are now connected.
6163

6264
</Procedure>
6365

@@ -71,3 +73,5 @@ To set up $CLOUD_LONG via AWS:
7173
[aws-paygo]: https://aws.amazon.com/marketplace/pp/prodview-iestawpo5ihca?applicationId=AWSMPContessa&ref_=beagle&sr=0-1
7274
[aws-annual-commit]: https://aws.amazon.com/marketplace/pp/prodview-ezxwlmjyr6x4u?applicationId=AWSMPContessa&ref_=beagle&sr=0-2
7375
[timescale-signup]: https://console.cloud.timescale.com/signup
76+
[console-billing]: https://console.cloud.timescale.com/dashboard/billing/plans
77+
[pricing-plans]: /about/:currentVersion:/pricing-and-account-management/

0 commit comments

Comments
 (0)