Skip to content

Commit

Permalink
[Getting started] Continue adding frontmatter (github#1301)
Browse files Browse the repository at this point in the history
* [Getting started] Continue adding frontmatter

Keep adding frontmatter for excerpts, keywords, and tags

* Fix links
  • Loading branch information
charislam authored Jul 13, 2022
1 parent 3960c3a commit 0e76128
Show file tree
Hide file tree
Showing 10 changed files with 94 additions and 34 deletions.
9 changes: 8 additions & 1 deletion getting-started/add-data.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
title: Add time-series data
excerpt: Add time-series data to your TimescaleDB instance
keywords: [ingest]
tags: [add, data, time-series]
---

# Add time-series data
To explore TimescaleDB's features, you need some sample data. This tutorial
provides real-time stock trade data, also known as tick data, from
Expand Down Expand Up @@ -98,4 +105,4 @@ Now that you have data in your TimescaleDB instance, learn how to [query the
data][query-data].

[twelve-data]: https://twelvedata.com/
[query-data]: /query-data/
[query-data]: /getting-started/:currentVersion:/query-data/
14 changes: 10 additions & 4 deletions getting-started/compress-data.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Compression
excerpt: Use TimescaleDB's native compression to save on storage
keywords: [compression]
---

# Compression
TimescaleDB includes native compression capabilities which enable you to
analyze and query massive amounts of historical time-series data inside a
Expand Down Expand Up @@ -157,10 +163,10 @@ For an introduction to compression algorithms, see this blog post:

For more information, see the [compression docs][compression-docs].

[data-retention]: /data-retention/
[alter-table-compression]: /api/:currentVersion:/compression/alter_table_compression/
[columnar-compression]: https://blog.timescale.com/blog/building-columnar-compression-in-a-row-oriented-database/
[compression-algorithms]: https://blog.timescale.com/blog/time-series-compression-algorithms-explained/
[compression-docs]: /timescaledb/:currentVersion:/how-to-guides/compression
[alter-table-compression]: /api/:currentVersion:/compression/alter_table_compression/
[compress-automatic]: /api/:currentVersion:/compression/add_compression_policy/
[compress-manual]: /api/:currentVersion:/compression/compress_chunk/
[compression-algorithms]: https://blog.timescale.com/blog/time-series-compression-algorithms-explained/
[compression-docs]: /timescaledb/:currentVersion:/how-to-guides/compression
[data-retention]: /getting-started/:currentVersion:/data-retention/
20 changes: 13 additions & 7 deletions getting-started/create-cagg/create-cagg-basics.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Creating continuous aggregates
excerpt: Create a continuous aggregate from your data
keywords: [continuous aggregates, create]
---

# Creating continuous aggregates
Now that you've been introduced to continuous aggregates, create your own
continuous aggregate from your data.
Expand Down Expand Up @@ -160,13 +166,13 @@ trading bot with TimescaleDB][crypto-bot].
Detailed information on continuous aggregates and real-time aggregation can be
found in the [continuous aggregates docs][continuous-aggregates].

[flightaware]: https://blog.timescale.com/blog/how-flightaware-fuels-flight-prediction-models-with-timescaledb-and-grafana/
[crypto-bot]: https://blog.timescale.com/blog/how-i-power-a-successful-crypto-trading-bot-with-timescaledb/
[continuous-aggregates]: /timescaledb/:currentVersion:/how-to-guides/continuous-aggregates
[cagg-policy]: /getting-started/:currentVersion:/create-cagg/create-cagg-policy/
[candlestick]: https://en.wikipedia.org/wiki/Candlestick_chart
[time-bucket]: /api/:currentVersion:/hyperfunctions/time_bucket/
[max]: https://www.postgresql.org/docs/current/tutorial-agg.html
[min]: https://www.postgresql.org/docs/current/tutorial-agg.html
[continuous-aggregates]: /timescaledb/:currentVersion:/how-to-guides/continuous-aggregates
[crypto-bot]: https://blog.timescale.com/blog/how-i-power-a-successful-crypto-trading-bot-with-timescaledb/
[first]: /api/:currentVersion:/hyperfunctions/first/
[flightaware]: https://blog.timescale.com/blog/how-flightaware-fuels-flight-prediction-models-with-timescaledb-and-grafana/
[last]: /api/:currentVersion:/hyperfunctions/last/
[cagg-policy]: /getting-started/:currentVersion:/create-cagg/create-cagg-policy/
[max]: https://www.postgresql.org/docs/current/tutorial-agg.html
[min]: https://www.postgresql.org/docs/current/tutorial-agg.html
[time-bucket]: /api/:currentVersion:/hyperfunctions/time_bucket/
14 changes: 10 additions & 4 deletions getting-started/create-cagg/create-cagg-policy.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Using and setting up continuous aggregate policies
excerpt: Set a policy to refresh your continuous aggregates automatically
keywords: [continuous aggregates, policies]
---

# Using and setting up continuous aggregate policies
You now have a continuous aggregate, but you have not updated any data or
created an automatic policy. There are two ways to update a continuous
Expand Down Expand Up @@ -88,9 +94,9 @@ trading bot with TimescaleDB][crypto-bot].
For detailed information on continuous aggregates and real-time aggregation,
see the [continuous aggregates section][continuous-aggregates].
[getting-started-compression]: /getting-started/:currentVersion:/compress-data/
[flightaware]: https://blog.timescale.com/blog/how-flightaware-fuels-flight-prediction-models-with-timescaledb-and-grafana/
[crypto-bot]: https://blog.timescale.com/blog/how-i-power-a-successful-crypto-trading-bot-with-timescaledb/
[auto-refresh]: /api/:currentVersion:/continuous-aggregates/add_continuous_aggregate_policy/
[continuous-aggregates]: /timescaledb/:currentVersion:/how-to-guides/continuous-aggregates
[crypto-bot]: https://blog.timescale.com/blog/how-i-power-a-successful-crypto-trading-bot-with-timescaledb/
[flightaware]: https://blog.timescale.com/blog/how-flightaware-fuels-flight-prediction-models-with-timescaledb-and-grafana/
[getting-started-compression]: /getting-started/:currentVersion:/compress-data/
[manual-refresh]: /api/:currentVersion:/continuous-aggregates/refresh_continuous_aggregate/
[auto-refresh]: /api/:currentVersion:/continuous-aggregates/add_continuous_aggregate_policy/
12 changes: 9 additions & 3 deletions getting-started/create-cagg/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Create a continuous aggregate
excerpt: Learn how to speed up queries with continuous aggregates
keywords: [continuous aggregates, create]
---

# Create a continuous aggregate
Aggregates are summaries of raw data for a period of time. Some examples of
aggregates include the average stock price per day, the maximum CPU utilization
Expand Down Expand Up @@ -48,7 +54,7 @@ You only get the full benefits of continuous aggregates by creating both the
aggregate itself and its policy. Follow both sections to add the full value of
aggregates to your time-series database.

[material-view]: https://www.postgresql.org/docs/current/rules-materializedviews.html
[cagg-overview]: /timescaledb/:currentVersion:/overview/core-concepts/continuous-aggregates/
[create-cagg-basics]: /create-cagg/create-cagg-basics/
[create-cagg-policy]: /create-cagg/create-cagg-policy/
[create-cagg-basics]: /getting-started/:currentVersion:/create-cagg/create-cagg-basics/
[create-cagg-policy]: /getting-started/:currentVersion:/create-cagg/create-cagg-policy/
[material-view]: https://www.postgresql.org/docs/current/rules-materializedviews.html
10 changes: 8 additions & 2 deletions getting-started/create-hypertable.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Create a hypertable
excerpt: Create a hypertable to store your time-series data
keywords: [hypertables, create]
---

# Create a hypertable
Hypertables are the core of TimescaleDB. Hypertables enable TimescaleDB to work
efficiently with time-series data. Because TimescaleDB is PostgreSQL, all the
Expand Down Expand Up @@ -110,7 +116,7 @@ To learn more about hypertables and best practices for configuring chunks, see
[Hypertable How-To][hypertable-how-to]. For information about how hypertables
help with storing and querying data, see the [hypertables and chunks core concepts page][core-concepts-hypertables].

[add-data]: /add-data/
[add-data]: /getting-started/:currentVersion:/add-data/
[core-concepts-hypertables]: /timescaledb/:currentVersion:/overview/core-concepts/hypertables-and-chunks/
[hypertable-how-to]: /timescaledb/:currentVersion:/how-to-guides/hypertables/
[create-hypertable]: /api/:currentVersion:/hypertable/create_hypertable
[hypertable-how-to]: /timescaledb/:currentVersion:/how-to-guides/hypertables/
6 changes: 6 additions & 0 deletions getting-started/data-retention.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Create a data retention policy
excerpt: Automatically drop historical data with a data retention policy
keywords: [data retention, policies, create]
---

# Create a data retention policy
An intrinsic part of working with time-series data is that the relevance of data
can diminish over time. As new data accumulates, old data becomes less valuable and
Expand Down
11 changes: 8 additions & 3 deletions getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Getting started with TimescaleDB
excerpt: Get started with your first TimescaleDB instance
---

# Getting started with TimescaleDB

**Congratulations!** You're here because you have successfully spun
Expand Down Expand Up @@ -37,8 +42,8 @@ If you have any questions or concerns as you go through the tutorial,
check out the Timescale community [Slack][slack] and [Timescale Forum][forum], where
you can find help from the Timescale community and team.

[install]: /install/:currentVersion:/
[connecting]: /timescaledb/:currentVersion:/how-to-guides/connecting/
[twelve-data]: https://twelvedata.com/
[slack]: https://slack.timescale.com/
[forum]: https://www.timescale.com/forum
[install]: /install/:currentVersion:/
[slack]: https://slack.timescale.com/
[twelve-data]: https://twelvedata.com/
12 changes: 9 additions & 3 deletions getting-started/next-steps.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Next steps
excerpt: Continue exploring TimescaleDB
keywords: [migrate, ingest, visualize, connect]
---

# Next steps
Now that you've had some hands-on experience with TimescaleDB, hopefully you can
see how many of Timescale's powerful features can help you manage your
Expand Down Expand Up @@ -48,9 +54,9 @@ datasets. We have you covered! 🙌
Have a look some of the [other datasets][sample-data] provided for you to dig
deeper into time-series data and data analysis using TimescaleDB.

[migrate-data]: /timescaledb/:currentVersion:/how-to-guides/migrate-data/
[visualize-data]: /timescaledb/:currentVersion:/tutorials/grafana/
[connect-with-code]: /timescaledb/:currentVersion:/quick-start/
[sample-data]: /timescaledb/:currentVersion:/tutorials/sample-datasets/
[ingest-real-time]: /timescaledb/:currentVersion:/tutorials/ingest-real-time-websocket-data
[migrate-data]: /timescaledb/:currentVersion:/how-to-guides/migrate-data/
[sample-data]: /timescaledb/:currentVersion:/tutorials/sample-datasets/
[twelve-data]: https://twelvedata.com/
[visualize-data]: /timescaledb/:currentVersion:/tutorials/grafana/
20 changes: 13 additions & 7 deletions getting-started/query-data.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
title: Query your data
excerpt: Query your TimescaleDB data with the full power of SQL
keywords: [queries]
---

# Query your data
With TimescaleDB, there's no need to learn a custom query language, because
TimescaleDB supports full SQL. You can use your SQL knowledge along with the
Expand Down Expand Up @@ -186,14 +192,14 @@ For more information about the functions provided by TimescaleDB and Timescale T
see the [API Reference for hyperfunctions](/api/:currentVersion:/hyperfunctions).

[average]: https://www.postgresql.org/docs/14/functions-aggregate.html
[clause-expressions]: https://www.postgresql.org/docs/14/queries-table-expressions.html
[create-cagg]: /getting-started/:currentVersion:/create-cagg/
[date-trunc]: https://www.postgresql.org/docs/current/functions-datetime.html
[filter]: https://www.postgresql.org/docs/14/sql-expressions.html#SYNTAX-AGGREGATES
[first]: /api/:currentVersion:/hyperfunctions/first
[join]: https://www.postgresql.org/docs/current/tutorial-join.html
[last]: /api/:currentVersion:/hyperfunctions/last
[order-by]: https://www.postgresql.org/docs/current/queries-order.html
[select-keywords]: https://www.postgresql.org/docs/14/sql-select.html
[clause-expressions]: https://www.postgresql.org/docs/14/queries-table-expressions.html
[time-bucket]: /api/:currentVersion:/hyperfunctions/time_bucket
[time-bucket-how-to]: /timescaledb/:currentVersion:/how-to-guides/time-buckets/
[last]: /api/:currentVersion:/hyperfunctions/last
[first]: /api/:currentVersion:/hyperfunctions/first
[date-trunc]: https://www.postgresql.org/docs/current/functions-datetime.html
[create-cagg]: /create-cagg/
[join]: https://www.postgresql.org/docs/current/tutorial-join.html
[time-bucket]: /api/:currentVersion:/hyperfunctions/time_bucket

0 comments on commit 0e76128

Please sign in to comment.