Skip to content

Commit ccb9aad

Browse files
committed
Merge branch 'milestone-28-azure-cloud' of github.com:timescale/docs into 501-rework-supported-platforms-doc-with-tabs
# Conflicts: # about/supported-platforms.md # use-timescale/regions.md
2 parents 0bee446 + 7280a01 commit ccb9aad

File tree

210 files changed

+4741
-927
lines changed

Some content is hidden

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

210 files changed

+4741
-927
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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Integrate <third-party tool name> with Tiger Cloud
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
---
@@ -46,7 +46,7 @@ To connect to $CLOUD_LONG:
4646

4747
// Add only if there is a simple way to illustrate how the two solutions work together.
4848

49-
Take the following steps to <whatever the tool must do in conjunction with Tiger Cloud>:
49+
Take the following steps to <whatever the tool must do in conjunction with Tiger>:
5050

5151
<Procedure>
5252

.helper-scripts/llms/generate_llms_full.py

Lines changed: 10 additions & 10 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

@@ -61,7 +61,7 @@ def _load_comprehensive_variables(self) -> Dict[str, str]:
6161
'$LAKE_LONG': 'Tiger Lake',
6262
'$LAKE_SHORT': 'Tiger Lake',
6363
'$TIMESCALE_DB': 'TimescaleDB',
64-
'$PRODUCTS_ALL': 'TigerData products',
64+
'$PRODUCTS_ALL': 'Tiger Data products',
6565
'$PRODUCTS_CL_DB': 'Tiger Cloud and TimescaleDB',
6666
'$TDB_APACHE': 'TimescaleDB Apache 2 Edition',
6767
'$TDB_COMMUNITY': 'TimescaleDB Community Edition',
@@ -83,7 +83,7 @@ def _load_comprehensive_variables(self) -> Dict[str, str]:
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',
@@ -138,7 +138,7 @@ def _load_comprehensive_variables(self) -> Dict[str, str]:
138138
'$READ_REPLICA': 'read replica',
139139

140140
# Legacy/Backwards compatibility
141-
'$TIGER_POSTGRES': 'Tiger Postgres',
141+
'$TIGER_POSTGRES': 'TimescaleDB',
142142
'$POSTGRESQL': 'PostgreSQL',
143143

144144
# Additional Variables
@@ -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: 7 additions & 7 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.
@@ -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 Cloud 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
@@ -146,7 +146,7 @@ To make a documentation page more visible and clear for Google:
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

148148
- Title: Create a hypertable in Tiger Cloud
149-
- Description: Turn a regular $PG table into a hypertable in a few steps, using Tiger Cloud Console.
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: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
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

@@ -13,18 +13,18 @@
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 Cloud for free](https://img.shields.io/badge/Try_Tiger_Cloud_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/_caggs-function-support.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11

22
The following table summarizes the aggregate functions supported in continuous aggregates:
33

4-
|Function, clause, or feature|TimescaleDB 2.6 and earlier|TimescaleDB 2.7, 2.8, and 2.9|TimescaleDB 2.10 and later|
5-
|-|-|-|-|
6-
|Parallelizable aggregate functions||||
7-
|[non-parallelizable SQL aggregates][postgres-parallel-agg]||||
8-
|`ORDER BY`||||
9-
|Ordered-set aggregates||||
10-
|Hypothetical-set aggregates||||
11-
|`DISTINCT` in aggregate functions||||
12-
|`FILTER` in aggregate functions||||
13-
|`FROM` clause supports `JOINS`||||
4+
| Function, clause, or feature |TimescaleDB 2.6 and earlier|TimescaleDB 2.7, 2.8, and 2.9|TimescaleDB 2.10 and later|
5+
|------------------------------------------------------------|-|-|-|
6+
| Parallelizable aggregate functions ||||
7+
| [Non-parallelizable SQL aggregates][postgres-parallel-agg] ||||
8+
| `ORDER BY` ||||
9+
| Ordered-set aggregates ||||
10+
| Hypothetical-set aggregates ||||
11+
| `DISTINCT` in aggregate functions ||||
12+
| `FILTER` in aggregate functions ||||
13+
| `FROM` clause supports `JOINS` ||||
1414

1515

16-
DISTINCT works in aggregate functions not in the query definition. For example, for the table:
16+
DISTINCT works in aggregate functions, not in the query definition. For example, for the table:
1717

1818
```sql
1919
CREATE TABLE public.candle(

_partials/_caggs-intro.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
11
import RealTimeAgg from 'versionContent/_partials/_real-time-aggregates.mdx';
22

33
In modern applications, data usually grows very quickly. This means that aggregating
4-
it into useful summaries can become very slow. Continuous aggregates in $TIMESCALE_DB make
5-
aggregating data lightning fast, accurate, and easy.
6-
7-
If you are collecting data very frequently, you might want to aggregate your
8-
data into minutes or hours instead. For example, if an IoT device takes
4+
it into useful summaries can become very slow. If you are collecting data very frequently, you might want to aggregate your
5+
data into minutes or hours instead. For example, if an IoT device takes
96
temperature readings every second, you might want to find the average temperature
107
for each hour. Every time you run this query, the database needs to scan the
11-
entire table and recalculate the average.
8+
entire table and recalculate the average. $TIMESCALE_DB makes aggregating data lightning fast, accurate, and easy with continuous aggregates.
9+
10+
![Reduced data calls with $CAGGs](https://assets.timescale.com/docs/images/continuous-aggregate.png)
1211

13-
Continuous aggregates are a kind of hypertable that is refreshed automatically
12+
Continuous aggregates in $TIMESCALE_DB are a kind of hypertable that is refreshed automatically
1413
in the background as new data is added, or old data is modified. Changes to your
1514
dataset are tracked, and the hypertable behind the continuous aggregate is
1615
automatically updated in the background.
1716

18-
You don't need to manually refresh your continuous aggregates, they are
19-
continuously and incrementally updated in the background. Continuous aggregates
20-
also have a much lower maintenance burden than regular $PG materialized
17+
Continuous aggregates have a much lower maintenance burden than regular $PG materialized
2118
views, because the whole view is not created from scratch on each refresh. This
2219
means that you can get on with working your data instead of maintaining your
2320
database.
2421

25-
2622
Because continuous aggregates are based on hypertables, you can query them in exactly the same way as your other tables. This includes continuous aggregates in the rowstore, compressed into the [columnstore][hypercore],
27-
or [tiered to object storage][data-tiering]. You can even create [continuous aggregates on top of your continuous aggregates][hierarchical-caggs] - for an even more fine-tuned aggregation.
23+
or [tiered to object storage][data-tiering]. You can even create [continuous aggregates on top of your continuous aggregates][hierarchical-caggs], for an even more fine-tuned aggregation.
2824

2925
[Real-time aggregation][real-time-aggregation] enables you to combine pre-aggregated data from the materialized view with the most recent raw data. This gives you up-to-date results on every query. <RealTimeAgg />
3026

_partials/_cloud-connect-service.md

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

23
<Procedure>
34

45
1. **Check your $SERVICE_SHORT is running correctly**
56

67
In [$CONSOLE][services-portal], check that your $SERVICE_SHORT is marked as `Running`.
78

8-
![Check $SERVICE_SHORT is running](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-cloud-console-services-view.png)
9+
![Check $SERVICE_SHORT is running](https://assets.timescale.com/docs/images/tiger-on-azure/tiger-console-services-view.png)
910

1011
1. **Connect to your $SERVICE_SHORT**
1112

@@ -15,13 +16,15 @@
1516

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

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

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

2225
1. Select your $SERVICE_SHORT in the connection drop-down in the top right.
2326

24-
![Select a connection](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-cloud-data-mode-connection-dropdown.png)
27+
![Select a connection](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-console-data-mode-connection-dropdown.png)
2528

2629
1. Run a test query:
2730

@@ -45,7 +48,7 @@
4548

4649
1. Click `SQL editor`.
4750

48-
![Check a $SERVICE_SHORT is running](https://assets.timescale.com/docs/images/tiger-cloud-console/tiger-cloud-ops-mode-sql-editor.png)
51+
![Check a $SERVICE_SHORT is running](https://assets.timescale.com/docs/images/tiger-on-azure/tiger-console-ops-mode-sql-editor-empty.png)
4952

5053
1. Run a test query:
5154

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import CreateAccountConsole from "versionContent/_partials/_create-account-console.mdx";
2+
3+
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.
4+
5+
<CreateAccountConsole />
6+
7+
[tsc-portal]: https://console.cloud.timescale.com/
8+
[timescale-website]: https://www.timescale.com/
9+
[aws-marketplace]: https://aws.amazon.com/marketplace
10+
[aws-paygo]: https://aws.amazon.com/marketplace/pp/prodview-iestawpo5ihca?applicationId=AWSMPContessa&ref_=beagle&sr=0-1
11+
[aws-annual-commit]: https://aws.amazon.com/marketplace/pp/prodview-ezxwlmjyr6x4u?applicationId=AWSMPContessa&ref_=beagle&sr=0-2
12+
[timescale-signup]: https://console.cloud.timescale.com/signup

0 commit comments

Comments
 (0)