From c983395d1c8fb665a3b78f5b42c3c41d74bc5dc7 Mon Sep 17 00:00:00 2001 From: Lana Brindley Date: Thu, 18 May 2023 00:49:08 +1000 Subject: [PATCH] Review instances of TimescaleDB (#2357) * Cloud without Cloud - Part One * Cloud without Cloud - Part Two * Reviewed instances of TimescaleDB * Apply suggestions from code review Co-authored-by: gina-alioto <113025888+gina-alioto@users.noreply.github.com> Signed-off-by: Lana Brindley --------- Signed-off-by: Lana Brindley Signed-off-by: Charis <26616127+charislam@users.noreply.github.com> Co-authored-by: gina-alioto <113025888+gina-alioto@users.noreply.github.com> Co-authored-by: Charis <26616127+charislam@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- README.md | 2 +- .../toolkit/stats_agg-one-variable.md | 2 +- .../toolkit/stats_agg-two-variables.md | 2 +- .../_create-hypertable-twelvedata-crypto.md | 2 +- ...pdate-timescaledb-could-not-access-file.md | 2 +- about/contribute-to-docs.md | 26 +++++------ about/contribute-to-timescale.md | 16 +++---- api/actions.md | 2 +- api/add_data_node.md | 4 +- api/add_dimension.md | 6 +-- mst/aiven-client/grafana-email.md | 2 +- mst/index.md | 2 +- mst/ingest-data.md | 2 +- mst/installation-mst.md | 2 +- mst/migrate-to-cloud.md | 3 +- mst/mst-multi-node.md | 15 +++--- mst/security.md | 2 +- mst/viewing-service-logs.md | 4 +- mst/vpc-peering/vpc-peering-aws-transit.md | 2 +- mst/vpc-peering/vpc-peering-gcp.md | 4 +- package.json | 2 +- quick-start/index.md | 2 +- .../uninstall/uninstall-timescaledb.md | 10 ++-- tutorials/page-index/page-index.js | 46 +++++++++---------- use-timescale/alerting.md | 14 +++--- .../compression/decompress-chunks.md | 2 +- use-timescale/compression/index.md | 2 +- .../configuration/about-configuration.md | 2 +- .../configuration/customize-configuration.md | 4 +- use-timescale/configuration/index.md | 4 +- use-timescale/continuous-aggregates/time.md | 2 +- .../data-retention/about-data-retention.md | 4 +- ...ta-retention-with-continuous-aggregates.md | 2 +- .../distributed-hypertables/insert.md | 2 +- .../hypertables/about-hypertables.md | 4 +- use-timescale/index.md | 2 +- use-timescale/ingest-data/about-ingesting.md | 8 ++-- .../about-timescaledb-parallel-copy.md | 6 +-- use-timescale/ingest-data/index.md | 8 ++-- use-timescale/ingest-data/ingest-kafka.md | 6 +-- use-timescale/ingest-data/ingest-telegraf.md | 17 +++---- use-timescale/time-buckets/index.md | 2 +- .../user-defined-actions/example-backfill.md | 2 +- .../example-downsample-and-compress.md | 2 +- .../example-generic-retention.md | 2 +- .../example-tiered-storage.md | 2 +- use-timescale/user-defined-actions/index.md | 6 +-- .../write-data/about-writing-data.md | 6 +-- use-timescale/write-data/delete.md | 4 +- use-timescale/write-data/insert.md | 2 +- 51 files changed, 141 insertions(+), 140 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e83d8da8ea..bf685f7828 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Introduction -There are multiple ways to help make TimescaleDB better, including contributing +There are multiple ways to help make Timescale better, including contributing to the documentation. All of our documentation is available to use and review with GitHub. diff --git a/README.md b/README.md index 0ae234b1eb..f79d57ff28 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ repository, which pulls in content from this repository on each build. ## Contributing We welcome and appreciate any help the community can provide to make -TimescaleDB's documentation better. +Timescale's documentation better. You can help either by opening an [issue](https://github.com/timescale/docs/issues) with diff --git a/_code-samples/toolkit/stats_agg-one-variable.md b/_code-samples/toolkit/stats_agg-one-variable.md index 5ef50c67f1..e29dc8f879 100644 --- a/_code-samples/toolkit/stats_agg-one-variable.md +++ b/_code-samples/toolkit/stats_agg-one-variable.md @@ -18,7 +18,7 @@ see [Statistical Aggregates (2D)](./stats_agg_2D.md). In order to make common statistical aggregates easier to work with in window functions and continuous aggregates, Toolkit provides common statistical aggregates in a slightly different form than otherwise available in -PostgreSQL/TimescaleDB. They are re-implemented within the [two-step aggregates +PostgreSQL or TimescaleDB. They are re-implemented within the [two-step aggregates framework](./two-step_aggregation.md) which exposes a summary form to the user which can then have multiple accessors. diff --git a/_code-samples/toolkit/stats_agg-two-variables.md b/_code-samples/toolkit/stats_agg-two-variables.md index d3aa38d75a..b1dbe7c1c7 100644 --- a/_code-samples/toolkit/stats_agg-two-variables.md +++ b/_code-samples/toolkit/stats_agg-two-variables.md @@ -19,7 +19,7 @@ For 1D statistical functions, see [Statistical Aggregates In order to make common statistical aggregates easier to work with in window functions and continuous aggregates, Toolkit provides common statistical aggregates in a slightly different form than otherwise available in -PostgreSQL/TimescaleDB. They are re-implemented within the [two-step aggregates +PostgreSQL or TimescaleDB. They are re-implemented within the [two-step aggregates framework](./two-step_aggregation.md) which exposes a summary form to the user which can then have multiple accessors. diff --git a/_partials/_create-hypertable-twelvedata-crypto.md b/_partials/_create-hypertable-twelvedata-crypto.md index 87cf18b9f3..8f4d2517da 100644 --- a/_partials/_create-hypertable-twelvedata-crypto.md +++ b/_partials/_create-hypertable-twelvedata-crypto.md @@ -53,7 +53,7 @@ there is one other table of data called `crypto_assets`. ); ``` -1. You now have two tables within your TimescaleDB database. One hypertable +1. You now have two tables within your Timescale database. One hypertable named `crypto_ticks`, and one normal PostgreSQL table named `crypto_assets`. diff --git a/_troubleshooting/self-hosted/update-timescaledb-could-not-access-file.md b/_troubleshooting/self-hosted/update-timescaledb-could-not-access-file.md index 6b5cd81b71..af9442664d 100644 --- a/_troubleshooting/self-hosted/update-timescaledb-could-not-access-file.md +++ b/_troubleshooting/self-hosted/update-timescaledb-could-not-access-file.md @@ -24,7 +24,7 @@ the file mentioned is from the previous version, it is probably due to an incomp update process. Within the greater PostgreSQL server instance, each database that has TimescaleDB installed needs to be updated with the SQL command `ALTER EXTENSION timescaledb UPDATE;` while connected to that database. Otherwise, -the database will be looking for the previous version of the timescaledb files. +the database looks for the previous version of the timescaledb files. See [our update docs][update-db] for more info. diff --git a/about/contribute-to-docs.md b/about/contribute-to-docs.md index fb32fc3b7a..916aaef29b 100644 --- a/about/contribute-to-docs.md +++ b/about/contribute-to-docs.md @@ -1,6 +1,6 @@ --- -title: Contribute to TimescaleDB documentation -excerpt: Advice and style guide for contributing to TimescaleDB documentation +title: Contribute to Timescale documentation +excerpt: Advice and style guide for contributing to Timescale documentation keywords: [contribute] tags: [docs, style guide] --- @@ -97,9 +97,9 @@ phrase possible. For example, instead of "Using hypertables", call the page "Hypertables". For level two sections that contain one or more procedures, use a simple verb -phrase. For example, "Install TimescaleDB". For the associated procedures, use a +phrase. For example, "Install Timescale". For the associated procedures, use a level three heading, with the gerund form of the same heading. For example, -"Installing TimescaleDB". +"Installing Timescale". ## Lists @@ -153,13 +153,13 @@ Procedures contain these elements: For example: ```txt -## Install TimescaleDB +## Install Timescale -This section describes how to install TimescaleDB on premise. +This section describes how to install Timescale on premise. -### Installing TimescaleDB +### Installing Timescale 1. Start each step with a verb, or a location. 1. For example, "Run the `example` command", or "At the command prompt, open the @@ -233,9 +233,9 @@ device. *Adverbs* : Do not use. -❌ Simply install TimescaleDB. +❌ Simply install Timescale. -👍 Install TimescaleDB. +👍 Install Timescale. *AWS* : Amazon Web Services. No need to expand this acronym. @@ -257,12 +257,12 @@ device. ❌ "Perform a bare metal installation." -👍 "Install TimescaleDB on bare metal." +👍 "Install Timescale on bare metal." *Bare-metal* : Adjective. -❌ "Install TimescaleDB on bare-metal." +❌ "Install Timescale on bare-metal." 👍 "Perform a bare-metal installation." @@ -413,9 +413,9 @@ device. *Simply* : Don't use. -❌ Simply install TimescaleDB. +❌ Simply install Timescale. -👍 Install TimescaleDB. +👍 Install Timescale. *Superuser* : One word. diff --git a/about/contribute-to-timescale.md b/about/contribute-to-timescale.md index b31dd226d9..a55561285c 100644 --- a/about/contribute-to-timescale.md +++ b/about/contribute-to-timescale.md @@ -1,21 +1,21 @@ --- -title: Contribute to TimescaleDB -excerpt: Learn more about how to contribute to TimescaleDB +title: Contribute to Timescale +excerpt: Learn more about how to contribute to Timescale keywords: [contribute] tags: [github] --- -# Contributing to TimescaleDB +# Contributing to Timescale -There are multiple ways to help make TimescaleDB better. All of our documentation -and source for the PostgreSQL extension are available to use and review via +There are multiple ways to help make TimescaleDB better. All of the documentation +and source for the PostgreSQL extension are available to use and review on GitHub. ## Contributing to Timescale documentation Timescale documentation is hosted in a [GitHub repository][github-docs] and is open for contribution from all community members. If you -find errors or would like to add content to our docs, this tutorial +find errors or would like to add content to the docs, this tutorial walks you through the process. ### Making minor changes @@ -51,8 +51,8 @@ There are multiple ways you can help: * Open an issue with a bug report, build issue, feature request, suggestion, etc. * Fork this repository and submit a pull request -[Head over to our GitHub repository][github-timescaledb] for TimescaleDB to learn more about how you -can help and to review our coding style guide! +[Head over to our GitHub repository][github-timescaledb] for TimescaleDB to learn +more about how you can help and to review our coding style guide! [github-docs]: https://github.com/timescale/docs [github-timescaledb]: https://github.com/timescale/timescaledb/blob/master/CONTRIBUTING.md diff --git a/api/actions.md b/api/actions.md index d052e0fe80..83768c2255 100644 --- a/api/actions.md +++ b/api/actions.md @@ -8,7 +8,7 @@ tags: [user-defined actions, background jobs, scheduled jobs, automation framewo # User-Defined Actions Community User-defined actions allow you to run functions and procedures implemented in a -language of your choice on a schedule within TimescaleDB. This allows +language of your choice on a schedule within Timescale. This allows automatic periodic tasks that are not covered by existing policies and even enhancing existing policies with additional functionality. diff --git a/api/add_data_node.md b/api/add_data_node.md index 79000a79ad..78eb7fb68a 100644 --- a/api/add_data_node.md +++ b/api/add_data_node.md @@ -34,8 +34,8 @@ the data node by: 1. Creating the database given in `database` that serve as the new data node. -2. Loading the TimescaleDB extension in the new database. -3. Setting metadata to make the data node part of the distributed +1. Loading the TimescaleDB extension in the new database. +1. Setting metadata to make the data node part of the distributed database. Note that user roles are not automatically created on the new data diff --git a/api/add_dimension.md b/api/add_dimension.md index 9db7d0fd25..eef59c7a56 100644 --- a/api/add_dimension.md +++ b/api/add_dimension.md @@ -11,7 +11,7 @@ api: # add_dimension() -Add an additional partitioning dimension to a TimescaleDB hypertable. +Add an additional partitioning dimension to a Timescale hypertable. The column selected as the dimension can either use interval partitioning (for example, for a second time partition) or hash partitioning. @@ -61,7 +61,7 @@ Thus, users looking for parallel I/O have two options: single logical disk to the hypertable (that is, via a single tablespace). 1. For each physical disk, add a separate tablespace to the -database. TimescaleDB allows you to actually add multiple tablespaces +database. Timescale allows you to actually add multiple tablespaces to a *single* hypertable (although under the covers, a hypertable's chunks are spread across the tablespaces associated with that hypertable). @@ -74,7 +74,7 @@ tablespace approach only supports the former. With a RAID setup, That said, when using space partitions, we recommend using 1 space partition per disk. -TimescaleDB does *not* benefit from a very large number of space +Timescale does *not* benefit from a very large number of space partitions (such as the number of unique items you expect in partition field). A very large number of such partitions leads both to poorer per-partition load balancing (the mapping of items to partitions using diff --git a/mst/aiven-client/grafana-email.md b/mst/aiven-client/grafana-email.md index 40c0fcc6f7..c1fee66d48 100644 --- a/mst/aiven-client/grafana-email.md +++ b/mst/aiven-client/grafana-email.md @@ -62,7 +62,7 @@ Before you begin, make sure you have: -c smtp_server.from_address="grafana@yourcompany.com" ``` -1. (*OPTIONAL*) Review all available custom options, and configure: +1. Review all available custom options, and configure: ```bash avn service types -v diff --git a/mst/index.md b/mst/index.md index 52fbe4666e..e9b1ea64f4 100644 --- a/mst/index.md +++ b/mst/index.md @@ -1,6 +1,6 @@ --- title: Managed Service for TimescaleDB -excerpt: A fully managed TimescaleDB service on AWS, Azure, or GCP, available in more than 75 regions +excerpt: A fully managed TimescaleDB service on Azure or GCP products: [mst] --- diff --git a/mst/ingest-data.md b/mst/ingest-data.md index 9687d6a1bf..5e48f0269b 100644 --- a/mst/ingest-data.md +++ b/mst/ingest-data.md @@ -78,7 +78,7 @@ one of these methods. ## Bulk upload from CSV files If you have a dataset stored in a `.csv` file, you can import it into an empty -TimescaleDB hypertable. You need to begin by creating the new table, before you +hypertable. You need to begin by creating the new table, before you import the data. diff --git a/mst/installation-mst.md b/mst/installation-mst.md index cd615c07aa..5d4680d8f3 100644 --- a/mst/installation-mst.md +++ b/mst/installation-mst.md @@ -71,7 +71,7 @@ cloud provider, which you can install your database on. Your Managed Service for TimescaleDB trial includes up to US$300 credit for you -to use. This is enough to complete all our tutorials and run a few test projects +to use. This is enough to complete all the tutorials and run a few test projects of your own. diff --git a/mst/migrate-to-cloud.md b/mst/migrate-to-cloud.md index 58453ac993..6cec88d5b0 100644 --- a/mst/migrate-to-cloud.md +++ b/mst/migrate-to-cloud.md @@ -8,6 +8,7 @@ keywords: [data migration] # Migrate your Managed Service for TimescaleDB data to Timescale If you prefer Timescale's features, you can migrate your data from Managed -Service for TimescaleDB to Timescale using the Hypershift tool. To learn about hypershift, see the [migration section][migration]. +Service for TimescaleDB to Timescale using the hypershift tool. To learn about +hypershift, see the [migration section][migration]. [migration]: /use-timescale/:currentVersion:/migration/ diff --git a/mst/mst-multi-node.md b/mst/mst-multi-node.md index 477842f4b7..96e4b0e8a3 100644 --- a/mst/mst-multi-node.md +++ b/mst/mst-multi-node.md @@ -18,7 +18,7 @@ supercharge time-series data even further. One of the most anticipated new features is what we call **multi-node** - the ability to create a cluster of TimescaleDB instances to scale both reads and writes. -In this How To, we'll show you how to create a multi-node cluster in your +This section shows you how to create a multi-node cluster in your Managed Service for TimescaleDB account with TimescaleDB 2.0 as a "do-it-yourself" (DIY) multi-node experience. @@ -26,7 +26,7 @@ Managed Service for TimescaleDB account with TimescaleDB 2.0 as a Multi-node clusters consist of at least two or more TimescaleDB instances (called **Services** in Managed Service for TimescaleDB). Each cluster has one -access node (AN) and one or more data nodes (DN). As outlined in our +access node (AN) and one or more data nodes (DN). As outlined in these [architecture blog posts][distributed-architecture], the access node is intended to be the only TimescaleDB instance that you or your applications connect to once the cluster is set up. It becomes the "brains" and traffic controller of @@ -235,15 +235,14 @@ server: 1. There is no limitation on the number of distributed hypertables a user can create on the access node. 1. Finally, remember that once a Service is marked as an access node or data - node, it cannot be used as part of another TimescaleDB multi-node cluster. + node, it cannot be used as part of another multi-node cluster. ## Maintenance tasks -A multi-node TimescaleDB setup requires regular maintenance; in particular, -the distributed transaction log needs to be cleaned up and non-completed -transactions should be "healed." Please refer to our standard -[multi-node documentation][maintenance-tasks] for instructions on how to -configure a user-defined action for this task. +A multi-node setup requires regular maintenance; in particular, the distributed +transaction log needs to be cleaned up and non-completed transactions should be +"healed." Refer to the [multi-node documentation][maintenance-tasks] for +instructions on how to configure a user-defined action for this task. [changes-in-tsdb2]: /about/:currentVersion:/release-notes/changes-in-timescaledb-2/ [distributed-architecture]: https://blog.timescale.com/blog/building-a-distributed-time-series-database-on-postgresql/ diff --git a/mst/security.md b/mst/security.md index 78af5f2951..fa18062fca 100644 --- a/mst/security.md +++ b/mst/security.md @@ -152,7 +152,7 @@ There is no ability for any customer or member of the public to access any virtual machines used in Managed Service for TimescaleDB. Managed Service for TimescaleDB services are periodically assessed and penetration -tested for any security issues by an independent professional cyber security vendor. +tested for any security issues by an independent professional cyber-security vendor.