Skip to content

Commit

Permalink
404 fixes (github#229)
Browse files Browse the repository at this point in the history
* New issues from Moz, plus some general tidy-up

* Issue github#222

* Issue github#215 & remove unused links

* Others from Moz

* Moar 404s, syntax, etc.

* make fixing changes to links

Co-authored-by: Miranda Auhl <miranda@timescale.com>
Co-authored-by: Ryan Booz <ryan@timescale.com>
  • Loading branch information
3 people authored Aug 3, 2021
1 parent 86d41dd commit 87e1e4d
Show file tree
Hide file tree
Showing 16 changed files with 293 additions and 300 deletions.
2 changes: 1 addition & 1 deletion api/add_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ SELECT add_job('user_defined_action','1h');
Register the procedure `user_defined_action` to be run every hour.


[using-actions]: /timescaledb/latest/overview/core-concepts/user-defined-actions/
[using-actions]: /timescaledb/:currentVersion:/overview/core-concepts/user-defined-actions
4 changes: 2 additions & 2 deletions api/create_distributed_hypertable.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ defined). If there is no space partition, all the data for each time
slice will be written to a single data node.

**Time intervals:** Follow the same guideline in setting the `chunk_time_interval`
as with [`create_hypertable`](/hypertable/create_hypertable-best-practices),
as with [`create_hypertable`][create-hypertable],
bearing in mind that the calculation needs to be based on the memory
capacity of the data nodes. However, one additional thing to
consider, assuming space partitioning is being used, is that the
Expand Down Expand Up @@ -95,4 +95,4 @@ be removed in a future release. To avoid such inconsistency, we do not yet
recommend using `replication_factor` > 1, and instead rely on physical
replication of each data node if such fault-tolerance is required.

[create-hypertable]: /hypertable/create_hypertable/
[create-hypertable]: /timescaledb/:currentVersion:/how-to-guides/hypertables/best-practices
6 changes: 3 additions & 3 deletions api/get_telemetry_report.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## get_telemetry_report()
## get_telemetry_report()

If background [telemetry] is enabled, returns the string sent to our servers.
If telemetry is not enabled, outputs INFO message affirming telemetry is disabled
Expand All @@ -10,7 +10,7 @@ and returns a NULL report.
|---|---|
| `always_display_report` | BOOLEAN | Set to true to always view the report, even if telemetry is disabled |

### Sample Usage
### Sample Usage
If telemetry is enabled, view the telemetry report.
```sql
SELECT get_telemetry_report();
Expand All @@ -20,4 +20,4 @@ If telemetry is disabled, view the telemetry report locally.
SELECT get_telemetry_report(always_display_report := true);
```

[telemetry]: /how-to-guides/configuration/telemetry/
[telemetry]: /timescaledb/:currentVersion:/how-to-guides/configuration/telemetry
2 changes: 1 addition & 1 deletion api/percentile-approximation.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ continuous aggregate for re-aggregation using the above value functions.

[percentile_agg]: /hyperfunctions/percentile-approximation/percentile_agg/
[advanced_agg_methods]: /hyperfunctions/percentile-approximation/percentile-aggregation-methods/
[rollup]: /hyperfunctions/percentile-approximation/rollup-percentile/
[rollup]: /hyperfunctions/percentile-approximation/rollup-percentile
4 changes: 2 additions & 2 deletions timescale-cloud/cloud-multi-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ multi-node experience.
Multi-node clusters consist of at least two or more TimescaleDB instances
(called **Services** in Timescale Cloud). Each cluster has one access node
(AN) and one or more data nodes (DN). As outlined in our
[architecture blog posts][distributed-architechture], the access node is
[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 all distributed hypertable activity. In contrast, data nodes are
Expand Down Expand Up @@ -241,7 +241,7 @@ ask questions and learn from Timescale staff and other community members.
[maintenance-tasks]: /timescaledb/:currentVersion:/how-to-guides/multi-node-setup/
[slack]: https://slack.timescale.com/
[changes-in-tsdb2]: /timescaledb/:currentVersion:/overview/release-notes/changes-in-timescaledb-2/
[distributed-architechture]: https://blog.timescale.com/blog/building-a-distributed-time-series-database-on-postgresql/
[distributed-architecture]: https://blog.timescale.com/blog/building-a-distributed-time-series-database-on-postgresql/
[postgres-user-mapping]: https://www.postgresql.org/docs/current/view-pg-user-mappings.html
[sample-data]: /timescaledb/:currentVersion:/tutorials/sample-datasets/
[promscale]: https://github.com/timescale/promscale
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,5 @@ sudo service postgresql restart
```

[ubuntu-releases]: http://releases.ubuntu.com/
[config]: /administration/configuration/
[contact]: https://www.timescale.com/contact
[slack]: https://slack.timescale.com/
[multi-node-basic]: /how-to-guides/multi-node-setup/
[config]: /how-to-guides/configuration/
[update-tsdb-2]: /how-to-guides/update-timescaledb/update-timescaledb-2/
2 changes: 1 addition & 1 deletion timescaledb/overview/core-concepts/user-defined-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,4 +166,4 @@ SELECT add_job('downsample_compress','1d', config => '{"lag":"12 month"}');
```


[api-move_chunk]: /api/:currentVersion:/hypertable/move_chunks
[api-move_chunk]: /api/:currentVersion:/hypertable/move_chunk
4 changes: 2 additions & 2 deletions timescaledb/overview/limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ and, in particular, distributed hypertables. This section documents
the common limitations when using both regular and distributed
hypertables.

## Hypertable limitations [](hypertable-limitations)
## Hypertable limitations

- Foreign key constraints referencing a hypertable are not supported.
- Time dimensions (columns) used for partitioning cannot have NULL
Expand All @@ -17,7 +17,7 @@ hypertables.
not supported. This includes upserts (`INSERT ... ON CONFLICT
UPDATE`).

## Distributed hypertable limitations [](distributed-hypertable-limitations)
## Distributed hypertable limitations

All the limitations of regular hypertables also apply to distributed
hypertables. In addition, the following limitations apply specifically
Expand Down
25 changes: 13 additions & 12 deletions timescaledb/overview/release-notes/changes-in-timescaledb-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,25 +92,26 @@ also have been updated to work for distributed hypertables.

The following APIs to create and configure hypertables have changed:

* [`create_hypertable`](/api/:currentVersion:/hypertable/create_hypertable): The `main_table` parameter has been renamed to `relation`, and additional parameters for distributed hypertables have been added.
* [`set_chunk_time_interval`](/api/:currentVersion:/hypertable/set_chunk_time_interval), [`set_number_of_partitions`](/api/:currentVersion:/hypertable/set_number_partitions), [`add_dimension`](/api/:currentVersion:/hypertable/add_dimension): The `main_table` parameter has been renamed to `hypertable`.
* [`create_hypertable`](/api/:currentVersion:/hypertable/create_hypertable/): The `main_table` parameter has been renamed to `relation`, and additional parameters for distributed hypertables have been added.
* [`set_chunk_time_interval`](/api/:currentVersion:/hypertable/set_chunk_time_interval), [`set_number_of_partitions`](/api/:currentVersion:/distributed-hypertables/set_number_partitions), [`add_dimension`](/api/:currentVersion:/hypertable/add_dimension): The `main_table` parameter has been renamed to `hypertable`.

### Viewing information about hypertables

Consistent with our desire to improve visibility into all aspects of TimescaleDB configuration,
the following views and functions about hypertable information have been updated or added:
Consistent with our desire to improve visibility into all aspects of TimescaleDB
configuration, the following views and functions about hypertable information
have been updated or added:

* [`timescaledb_information.hypertables`](/api/:currentVersion:/informational-views/hypertables/)
* [`timescaledb_information.hypertables`](/api/:currentVersion:/informational-views/hypertables)
* The view with basic information about hypertables has been renamed from the singular “hypertable”.
* Some columns have new names for consistency with other views.
* Table size information has been removed and made available through new size functions discussed later.
* Additional columns have been added related to distributed hypertables.
* The view no longer shows internal hypertables for continuous aggregates and compression.
* For continuous aggregates, the internal materialized hypertable name is available in the `timescaledb_information.continuous_aggregates` view.
* [`timescaledb_information.dimensions`](/api/:currentVersion:/informational-views/dimensions/): A new view allows
* [`timescaledb_information.dimensions`](/api/:currentVersion:/informational-views/dimensions): A new view allows
users to see partitioning information and settings for various dimensions, such as the chunk time interval or
number of space partitions used in a hypertable.
* [`timescaledb_information.chunks`](/api/:currentVersion:/informational-views/chunks/): A new view allows users
* [`timescaledb_information.chunks`](/api/:currentVersion:/informational-views/chunks): A new view allows users
to see information about individual data chunks of all hypertables, including the tablespace or data node on which
each chunk is stored.
* [`show_chunks(relation)`](/api/:currentVersion:/hypertable/show_chunks): The function now requires providing a
Expand Down Expand Up @@ -398,12 +399,12 @@ dropped due to a data retention policy as discussed in the previous section.
In TimescaleDB 2.0, views surrounding continuous aggregates (and other policies) have been simplified and generalized.

#### Changes and additions
* [`timescaledb_information.continuous_aggregates`](https://docs.timescale.com/api/latest/continuous-aggregates/):
* [`timescaledb_information.continuous_aggregates`](/api/:currentVersion:/continuous-aggregates/):
now provides information related to the materialized view, which includes the view name and owner, the real
time aggregation flag, the materialization and the view definition (the select statement defining the view).
* [`timescaledb_information.jobs`](https://docs.timescale.com/api/latest/informational-views/jobs/): displays information for
* [`timescaledb_information.jobs`](/api/:currentVersion:/informational-views/jobs/): displays information for
all policies including continuous aggregates.
* [`timescaledb_information.job_stats`](https://docs.timescale.com/api/latest/informational-views/job_stats/): displays job
* [`timescaledb_information.job_stats`](/api/:currentVersion:/informational-views/job_stats/): displays job
statistics related to all jobs.

#### Removed
Expand Down Expand Up @@ -466,7 +467,7 @@ Creating (or removing) a compression policy now has explicit functions.
information about currently compressed chunks.
* [`timescaledb_information.compression_settings`](/api/:currentVersion:/informational-views/compression_settings)
: This new view gives information about the compression settings on hypertables.
* [`timescaledb_information.jobs`](/api/:currentVersion:/informational-views/jobs): General information about
* [`timescaledb_information.jobs`](/api/:currentVersion:/informational-views/jobs/): General information about
compression policies are now available in the main jobs view.

#### Removed
Expand All @@ -490,7 +491,7 @@ or action-specific settings.
* [`delete_job`](/api/:currentVersion:/actions/delete_job): Removes the job from the scheduler. This is equivalent to functions that remove policies for
built-in actions (e.g., `remove_retention_policy`).
* [`timescaledb_information.jobs`](/api/:currentVersion:/informational-views/jobs): The new view provides all job settings available, and it replaces all policy-specific views.
* [`timescaledb_information.jobs_stats`](/api/latest/informational-views/job_stats): The view presents statistics of executing jobs for policies and actions.
* [`timescaledb_information.jobs_stats`](/api/:currentVersion:/informational-views/job_stats): The view presents statistics of executing jobs for policies and actions.


## License information [](license-changes)
Expand Down
6 changes: 3 additions & 3 deletions timescaledb/overview/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ schema. Add chunk based refresh_continuous_aggregate.

## 2.3.1 (2021-07-05)

This maintenance release contains bug fixes since the 2.3.0 release.
This maintenance release contains bug fixes since the 2.3.0 release.
We deem it moderate priority for upgrading.

**Bug fixes**
Expand Down Expand Up @@ -967,7 +967,7 @@ parallel query coordination to the ChunkAppend node.
Previously ChunkAppend would rely on parallel coordination in the
underlying scans for parallel plans.

For more information on this release, read the [announcement blog](https://blog.timescale.com/blog/building-columnar-compression-in-a-row-oriented-database), this [tutorial](https://docs.timescale.com/latest/tutorials/compression-tutorial),
For more information on this release, read the [announcement blog](https://blog.timescale.com/blog/building-columnar-compression-in-a-row-oriented-database), this [tutorial](/timescaledb/:currentVersion:/getting-started/compress-data/),
and the [blog on data tiering](https://blog.timescale.com/blog/optimize-your-storage-costs-with-timescaledbs-data-tiering-functionality/).

**For this release only**, you will need to restart the database before running
Expand Down Expand Up @@ -1165,7 +1165,7 @@ the materialized aggregate the next time that the automated process executes.

For more information on this release, read our [blog on continuous aggregates](https://blog.timescale.com/blog/continuous-aggregates-faster-queries-with-automatically-maintained-materialized-views/),
[our docs overview](http://docs.timescale.com/timescaledb/:currentVersion:/overview/core-concepts/continuous-aggregates/),
and visit this [tutorial](http://docs.timescale.com/tutorials/continuous-aggs-tutorial).
and visit this [tutorial](/timescaledb/:currentVersion:/getting-started/create-cagg/).

**Major features**
* #1184 Add continuous aggregate functionality
Expand Down
2 changes: 1 addition & 1 deletion timescaledb/quick-start/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ A hypertable is defined by a standard schema with column names and types, with a
least one column specifying a time value.

<highlight type="tip">
The TimescaleDB documentation on [schema management and indexing](/how-to-guides/schema-management/indexing/) explains this in further detail.
The TimescaleDB documentation on [schema management and indexing](/timescaledb/latest/how-to-guides/schema-management/indexing) explains this in further detail.
</highlight>

Let's create this migration to modify the `page_loads` table and create a
Expand Down
Loading

0 comments on commit 87e1e4d

Please sign in to comment.