Merge branch 'latest' into 235-docs-rfc-update-the-api-ref-for-hypers…

…tore-and-compression-for-any-changes-due-to-the-hyperstore
timescale · Jan 16, 2025 · be89feb · be89feb
2 parents c849517 + 9e0e69f
commit be89feb
Show file tree

Hide file tree

Showing 29 changed files with 103 additions and 33 deletions.
diff --git a/.github/styles/templates/integration.md b/.github/styles/templates/integration.md
@@ -0,0 +1,72 @@
+---
+title: Integrate <third-party tool name> with Timescale Cloud 
+excerpt: SEO friendly explanation of why the user will do it
+keywords: [<third-party tool name>]
+---
+
+import IntegrationPrereqs from "versionContent/_partials/_integration-prereqs.mdx";
+
+# Integrate <third-party tool name> with $CLOUD_LONG
+
+// Explain what the third-party tool is and what it does in their own words, link to product docs. 
+
+// Provide context for the integration steps, for example, if an additional connector is used.
+
+// See https://docs.timescale.com/use-timescale/latest/integrations/grafana/ for an example. 
+
+## Prerequisites
+
+<IntegrationPrereqs />
+
+- Install <third-party tool name> // Mention both server and cloud versions, if present. Link to installation pages.
+
+## Connect your $SERVICE_LONG
+
+To connect to $CLOUD_LONG:
+
+<Procedure>
+
+1. **Log in to <third-party tool name>**
+
+    // Sub-steps, code, screenshots if necessary.
+
+1. **Configure the connection**
+
+   // Sub-steps, code, screenshots if necessary. Link to [Find your connection details][connection-info].
+
+   ...
+
+1. **Test the connection**
+
+   // Sub-steps, code, screenshots if necessary.
+
+</Procedure>
+
+## Test the integration with $CLOUD_LONG
+
+// Add only if there is a simple way to illustrate how the two solutions work together. 
+
+Take the following steps to <whatever the tool must do in conjunction with Timescale Cloud>:
+
+<Procedure>
+
+// Steps to test out the integration using a defined dataset. 
+
+</Procedure>
+
+You have successfully integrated <third-party tool> with $CLOUD_LONG.
+
+[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/_partials/_cloud-connect.md b/_partials/_cloud-connect.md
@@ -50,8 +50,8 @@ Quick recap. You:
 [portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql
 [account-portal]: https://console.cloud.timescale.com/dashboard/account
 [services-portal]: https://console.cloud.timescale.com/dashboard/services
-[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
 [popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode
 [run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor
-[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
 [hypertables]: /use-timescale/:currentVersion:/hypertables/about-hypertables/#hypertable-partitioning
diff --git a/_partials/_cloud-create-connect-tutorials.md b/_partials/_cloud-create-connect-tutorials.md
@@ -39,4 +39,4 @@ command-line utility. If you've used PostgreSQL before, you might already have
 </Procedure>
 
 [timescale-portal]: https://console.cloud.timescale.com/
-[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
diff --git a/_partials/_create-hypertable.md b/_partials/_create-hypertable.md
@@ -40,8 +40,8 @@ To create a hypertable:
 </Procedure>
 
 [services-portal]: https://console.cloud.timescale.com/dashboard/services
-[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
 [popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode
 [run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor
-[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
 [hypertables]: /use-timescale/:currentVersion:/hypertables/about-hypertables/#hypertable-partitioning
diff --git a/_troubleshooting/cloud-jdbc-authentication-support.md b/_troubleshooting/cloud-jdbc-authentication-support.md
@@ -2,7 +2,7 @@
 title: JDBC authentication type is not supported
 section: troubleshooting
 products: [cloud]
-topics: [integrations/query admin]
+topics: [integrations]
 errors:
   - language: text
     message: |-

diff --git a/getting-started/run-queries-from-console.md b/getting-started/run-queries-from-console.md
@@ -229,11 +229,11 @@ To use SQL editor with Timescale:
 [readreplica]: /use-timescale/:currentVersion:/ha-replicas/read-scaling/
 [run-popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode
 [run-sqleditor]: /getting-started/:currentVersion:/run-queries-from-console/#sql-editor
-[integrations]: /use-timescale/:currentVersion:/integrations/query-admin/
+[integrations]: /use-timescale/:currentVersion:/integrations/
 [timescale-console]: https://console.cloud.timescale.com/
 [portal-ops-mode]: https://console.cloud.timescale.com/dashboard/services
 [pricing-plan-features]: https://www.timescale.com/pricing#features
-[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
 [create-cloud-account]: /getting-started/:currentVersion:/services/#create-a-timescale-cloud-account
 [portal-data-mode]: https://console.cloud.timescale.com/dashboard/services?popsql
 [services-portal]: https://console.cloud.timescale.com/dashboard/services

diff --git a/getting-started/services.md b/getting-started/services.md
@@ -67,7 +67,7 @@ And that is it, you are up and running. Enjoy developing with $COMPANY.
 
 [tsc-portal]: https://console.cloud.timescale.com/
 [services-how-to]: /use-timescale/:currentVersion:/services/
-[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
 [create-an-account]: /getting-started/:currentVersion:/services/#create-a-timescale-cloud-account
 [create-a-service]: /getting-started/:currentVersion:/services/#create-a-timescale-cloud-service
 [connect-to-your-service]: /getting-started/:currentVersion:/services/#connect-to-your-service

diff --git a/lambda/redirects.js b/lambda/redirects.js
@@ -837,6 +837,10 @@ module.exports = [
     from: '/use-timescale/latest/integrations/query-admin/about-psql/',
     to: 'https://docs.timescale.com/use-timescale/latest/integrations/psql/',
   },
+    {
+      from: '/use-timescale/latest/integrations/query-admin/psql/',
+      to: 'https://docs.timescale.com/use-timescale/latest/integrations/psql/',
+    },
   {
     from: '/use-timescale/latest/integrations/query-admin/about-connecting/',
     to: 'https://docs.timescale.com/use-timescale/latest/integrations/find-connection-details/',

diff --git a/mst/installation-mst.md b/mst/installation-mst.md
@@ -122,7 +122,7 @@ You can always [contact us][contact] if you need help working something out, or
 if you want to have a chat.
 
 [contact]: https://www.timescale.com/contact
-[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
 [mst-docs]: /mst/:currentVersion:/
 [tutorials]: /tutorials/:currentVersion:/
 [mst-signup]: https://www.timescale.com/mst-signup

diff --git a/mst/migrate-to-mst.md b/mst/migrate-to-mst.md
@@ -129,7 +129,7 @@ them. The migration still occurs successfully.
 [install-mst]: /mst/:currentVersion:/installation-mst/#create-your-first-service
 [pg_dump]: https://www.postgresql.org/docs/current/app-pgdump.html
 [pg_restore]: https://www.postgresql.org/docs/current/app-pgrestore.html
-[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[psql]: /use-timescale/:currentVersion:/integrations/psql/
 [upgrading-postgresql]: https://kb-managed.timescale.com/en/articles/5368016-perform-a-postgresql-major-version-upgrade
 [upgrading-postgresql-self-hosted]: /self-hosted/:currentVersion:/upgrades/upgrade-pg/
 [upgrading-timescaledb]: /self-hosted/:currentVersion:/upgrades/major-upgrade/
diff --git a/quick-start/ruby.md b/quick-start/ruby.md
@@ -720,7 +720,7 @@ page by page, or all pages together, and group by path or not:
 [add-performance]: #add-performance-and-path-attributes-to-pageload
 [explore]: #explore-aggregation-functions
 [install]: /getting-started/latest/
-[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[psql-install]: /use-timescale/:currentVersion:/integrations/psql/
 [rails-guide]: https://guides.rubyonrails.org/getting_started.html
 [ab]: https://httpd.apache.org/docs/2.4/programs/ab.html
 [active-record-query]: https://guides.rubyonrails.org/active_record_querying.html

diff --git a/self-hosted/install/installation-macos.md b/self-hosted/install/installation-macos.md
@@ -80,7 +80,7 @@ And that is it! You have TimescaleDB running on a database on a self-hosted inst
 For the latest functionality, install MacOS 14 Sanoma. The oldest supported version is macOS 10.15 Catalina
 
 [homebrew]: https://docs.brew.sh/Installation
-[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
 [macports]: https://guide.macports.org/#installing.macports
 [install-from-source]: /self-hosted/:currentVersion:/install/installation-source/
 [install-postgresql]: https://www.postgresql.org/download/macosx/
diff --git a/self-hosted/install/installation-source.md b/self-hosted/install/installation-source.md
@@ -73,7 +73,7 @@ And that is it! You have TimescaleDB running on a database on a self-hosted inst
 
 <WhereTo />
 
-[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[install-psql]: /use-timescale/:currentVersion:/integrations/psql/
 [config]: /self-hosted/:currentVersion:/configuration/
 [postgres-download]: https://www.postgresql.org/download/
 [cmake-download]: https://cmake.org/download/

diff --git a/self-hosted/migration/entire-database.md b/self-hosted/migration/entire-database.md
@@ -118,7 +118,7 @@ information about compression and decompression, see [Compression][compression].
 [migrate-separately]: /self-hosted/:currentVersion:/migration/schema-then-data/
 [pg_dump]: https://www.postgresql.org/docs/current/app-pgdump.html
 [pg_restore]: https://www.postgresql.org/docs/current/app-pgrestore.html
-[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[psql]: /use-timescale/:currentVersion:/integrations/psql/
 [timescaledb_pre_restore]: /api/:currentVersion:/administration/#timescaledb_pre_restore
 [timescaledb_post_restore]: /api/:currentVersion:/administration/#timescaledb_post_restore
 [upgrading-postgresql-self-hosted]: /self-hosted/:currentVersion:/upgrades/upgrade-pg/

diff --git a/self-hosted/migration/schema-then-data.md b/self-hosted/migration/schema-then-data.md
@@ -210,7 +210,7 @@ the [compression section](https://docs.timescale.com/use-timescale/latest/compre
 [install-selfhosted]: /self-hosted/:currentVersion:/install/
 [pg_dump]: https://www.postgresql.org/docs/current/app-pgdump.html
 [pg_restore]: https://www.postgresql.org/docs/current/app-pgrestore.html
-[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[psql]: /use-timescale/:currentVersion:/integrations/psql/
 [timescaledb-parallel-copy]: https://github.com/timescale/timescaledb-parallel-copy
 [upgrading-postgresql]: https://kb-managed.timescale.com/en/articles/5368016-perform-a-postgresql-major-version-upgrade
 [upgrading-postgresql-self-hosted]: /self-hosted/:currentVersion:/upgrades/upgrade-pg/

diff --git a/tutorials/OLD-financial-candlestick-tick-data/index.md b/tutorials/OLD-financial-candlestick-tick-data/index.md
@@ -73,4 +73,4 @@ Follow this tutorial and see how to set up your TimescaleDB database to consume
 [create]: /tutorials/:currentVersion:/financial-candlestick-tick-data/create-candlestick-aggregates
 [query]: /tutorials/:currentVersion:/financial-candlestick-tick-data/query-candlestick-views
 [manage]: /tutorials/:currentVersion:/financial-candlestick-tick-data/advanced-data-management
-[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[psql]: /use-timescale/:currentVersion:/integrations/psql/
diff --git a/tutorials/OLD_analyze-bitcoin-blockchain/index.md b/tutorials/OLD_analyze-bitcoin-blockchain/index.md
@@ -47,4 +47,4 @@ this tutorial is to
 </Highlight>
 
 [install-timescale]: /getting-started/latest/
-[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql
+[psql-install]: /use-timescale/:currentVersion:/integrations/psql/
diff --git a/tutorials/OLD_analyze-intraday-stocks/index.md b/tutorials/OLD_analyze-intraday-stocks/index.md
@@ -51,4 +51,4 @@ pip install pandas
 [explore]: /tutorials/:currentVersion:/
 [fetch-ingest]: /tutorials/:currentVersion:/
 [install-timescale]: /getting-started/latest/
-[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql
+[psql-install]: /use-timescale/:currentVersion:/integrations/psql/
diff --git a/tutorials/OLD_nfl-analytics/index.md b/tutorials/OLD_nfl-analytics/index.md
@@ -60,6 +60,6 @@ This tutorial has a few sections to help you on your journey:
 [install-timescale]: /getting-started/latest/
 [join-data]: /tutorials/:currentVersion:/nfl-analytics/join-with-relational
 [kaggle-download]: https://www.kaggle.com/c/nfl-big-data-bowl-2021/data
-[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql
+[psql-install]: /use-timescale/:currentVersion:/integrations/psql/
 [toolkit]: /self-hosted/:currentVersion:/tooling/install-toolkit/
 [visualize-plays]: /tutorials/:currentVersion:/nfl-analytics/play-visualization/
diff --git a/tutorials/OLD_nfl-fantasy-league.md b/tutorials/OLD_nfl-fantasy-league.md
@@ -588,4 +588,4 @@ draw_play(game_id=2018112900,
 [extra-download]: https://assets.timescale.com/docs/downloads/nfl_2018.zip
 [install-timescale]: /getting-started/latest/
 [kaggle-download]: https://www.kaggle.com/c/nfl-big-data-bowl-2021/data
-[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql
+[psql-install]: /use-timescale/:currentVersion:/integrations/psql/
diff --git a/tutorials/OLD_nyc-taxi-cab.md b/tutorials/OLD_nyc-taxi-cab.md
@@ -828,5 +828,5 @@ querying by time and location.
 [migrate]: /use-timescale/:currentVersion:/migration/
 [parallel-copy]: https://github.com/timescale/timescaledb-parallel-copy
 [postgis]: http://postgis.net/documentation
-[setup-psql]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql
+[setup-psql]: /use-timescale/:currentVersion:/integrations/psql/
 [time-series-forecasting]: /tutorials/:currentVersion:/time-series-forecast/
diff --git a/tutorials/blockchain-analyze/index.md b/tutorials/blockchain-analyze/index.md
@@ -56,4 +56,4 @@ to graph the output in Grafana.
 [blockchain-query]: /tutorials/:currentVersion:/blockchain-query/beginner-blockchain-query/
 [blockchain-def]: https://www.pcmag.com/encyclopedia/term/blockchain
 [transactions-def]: https://www.pcmag.com/encyclopedia/term/bitcoin-transaction
-[grafana-setup]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/#add-your-timescale-cloud-service-as-a-data-source
+[grafana-setup]: /use-timescale/:currentVersion:/integrations/grafana/
diff --git a/tutorials/energy-data/index.md b/tutorials/energy-data/index.md
@@ -58,4 +58,4 @@ you through the steps to visualize the results in Grafana.
 [query-energy]: /tutorials/:currentVersion:/energy-data/query-energy/
 [compress-energy]: /tutorials/:currentVersion:/energy-data/compress-energy/
 [cloud-install]: /getting-started/:currentVersion:/#create-your-timescale-account
-[grafana-setup]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/#add-your-timescale-cloud-service-as-a-data-source
+[grafana-setup]: /use-timescale/:currentVersion:/integrations/grafana/
diff --git a/tutorials/nyc-taxi-geospatial/index.md b/tutorials/nyc-taxi-geospatial/index.md
@@ -63,4 +63,4 @@ information, and plotting the results in Grafana.
 [cloud-install]: /getting-started/:currentVersion:/#create-your-timescale-account
 [beginner-fleet]: /tutorials/:currentVersion:/nyc-taxi-cab/
 [plot-nyc]: /tutorials/:currentVersion:/nyc-taxi-geospatial/plot-nyc/
-[grafana-setup]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/#add-your-timescale-cloud-service-as-a-data-source
+[grafana-setup]: /use-timescale/:currentVersion:/integrations/grafana/
diff --git a/use-timescale/ingest-data/import-csv.md b/use-timescale/ingest-data/import-csv.md
@@ -79,7 +79,6 @@ To import data from a CSV file:
      ```bash
        timescaledb-parallel-copy \
        --connection $TARGET \
-       --db-name tsdb \
        --table <TABLE_NAME> \
        --file <FILE_NAME>.csv \
        --workers <NUM_WORKERS> \

diff --git a/use-timescale/integrations/find-connection-details.md b/use-timescale/integrations/find-connection-details.md
@@ -51,7 +51,5 @@ In the `Services` page of the $MST_CONSOLE_LONG, click the service you want to c
 
 </Tabs>
 
-[about-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
-[tsc-portal]: https://console.cloud.timescale.com/
 [console-services]: https://console.cloud.timescale.com/dashboard/services
 [postgres-config]: https://www.postgresql.org/docs/current/runtime-config-file-locations.html
diff --git a/use-timescale/integrations/grafana.md b/use-timescale/integrations/grafana.md
@@ -176,8 +176,5 @@ tutorial as a starting point.
 
 [nyc-taxi]: /tutorials/:currentVersion:/nyc-taxi-cab
 [grafana-website]: https://www.grafana.com
-[install-grafana]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/installation
-[tutorial-grafana-dashboards]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/#create-a-grafana-dashboard-and-panel
-[tutorial-grafana-geospatial]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/#visualize-geospatial-data
 [time-buckets]: /use-timescale/:currentVersion:/time-buckets/
 
diff --git a/use-timescale/integrations/index.md b/use-timescale/integrations/index.md
@@ -49,4 +49,4 @@ Some of the most in-demand integrations for $CLOUD_LONG are listed below, with l
 [grafana]: /use-timescale/:currentVersion:/integrations/grafana/
 [tableau]: /use-timescale/:currentVersion:/integrations/tableau/
 [terraform]: /use-timescale/:currentVersion:/integrations/terraform
-[postgresql-integrations]: https://slashdot.org/software/p/PostgreSQL/integrations/
+[postgresql-integrations]: https://slashdot.org/software/p/PostgreSQL/integrations/
diff --git a/use-timescale/metrics-logging/service-metrics.md b/use-timescale/metrics-logging/service-metrics.md
@@ -136,4 +136,4 @@ performance bottlenecks with `pg_stat_statements`][blog-pg_stat_statements].
 [metrics-dashboard]: /use-timescale/:currentVersion:/metrics-logging/service-metrics/
 [pg-stat]: /use-timescale/:currentVersion:/metrics-logging/service-metrics/#query-level-statistics-with-pg_stat_statements
 [blog-pg_stat_statements]: <https://www.timescale.com/blog/identify-postgresql-performance-bottlenecks-with-pg_stat_statements/>
-[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
+[psql]: /use-timescale/:currentVersion:/integrations/psql/