Skip to content

Commit 4403dd9

Browse files
committed
fix: LInks and headings. Replace latest with v2. Specify OSS v2 in headings. Closes fix(api-refs): specify v2 in InfluxDB OSS headings #5866, Closes Flux docs: replace /influxdb/latest with /influxdb/v2 #5864. Linting cleanup, removing terminal prompt from examples
1 parent 4887aa5 commit 4403dd9

File tree

29 files changed

+366
-230
lines changed

29 files changed

+366
-230
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The tests defined in `compose.yaml` use the dependencies and execution
6666
environment from this image.
6767

6868
```bash
69-
docker build -t influxdata:docs-pytest -f Dockerfile.pytest .
69+
docker build -t influxdata/docs-pytest:latest -f Dockerfile.pytest .
7070
```
7171

7272
### Run the documentation locally (optional)

Dockerfile.pytest

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ RUN apt-get update && apt-get upgrade -y && apt-get install -y \
3232
python3-venv \
3333
rsync \
3434
telegraf \
35-
wget
35+
wget \
36+
yq
3637

3738
# Install InfluxDB 3 Core
3839
RUN curl -O https://www.influxdata.com/d/install_influxdb3.sh \

compose.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,9 @@ services:
8484
- type: volume
8585
source: test-content
8686
target: /app/content
87+
- type: bind
88+
source: ./test/shared/influxdb-templates
89+
target: /root/influxdb-templates
8790
working_dir: /app
8891
cloud-dedicated-pytest:
8992
container_name: cloud-dedicated-pytest

content/enterprise_influxdb/v1/tools/api.md

Lines changed: 150 additions & 97 deletions
Large diffs are not rendered by default.

content/flux/v0/join-data/time.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: >
44
Use [`join.time()`](/flux/v0/stdlib/join/time/) to join two streams of data
55
based on time values in the `_time` column.
66
This type of join operation is common when joining two streams of
7-
[time series data](/influxdb/latest/reference/glossary/#time-series-data).
7+
[time series data](/influxdb/v2/reference/glossary/#time-series-data).
88
menu:
99
flux_v0:
1010
parent: Join data
@@ -31,7 +31,7 @@ list_code_example: |
3131
Use [`join.time()`](/flux/v0/stdlib/join/time/) to join two streams of data
3232
based on time values in the `_time` column.
3333
This type of join operation is common when joining two streams of
34-
[time series data](/influxdb/latest/reference/glossary/#time-series-data).
34+
[time series data](/influxdb/v2/reference/glossary/#time-series-data).
3535

3636
`join.time()` can use any of the available join methods.
3737
Which method you use depends on your desired behavior:

content/flux/v0/stdlib/contrib/jsternberg/influxdb/from.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Durations are relative to `now()`.
8686

8787
URL of the InfluxDB instance to query.
8888

89-
See [InfluxDB OSS URLs](/influxdb/latest/reference/urls/)
89+
See [InfluxDB OSS URLs](/influxdb/v2/reference/urls/)
9090
or [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/).
9191

9292
### org
@@ -97,7 +97,7 @@ Organization name.
9797

9898
### token
9999

100-
InfluxDB [API token](/influxdb/latest/security/tokens/).
100+
InfluxDB [API token](/influxdb/v2/security/tokens/).
101101

102102

103103

content/flux/v0/stdlib/contrib/jsternberg/influxdb/select.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ Records that evaluate to _null_ or `false` are not included in the output tables
119119

120120
URL of the InfluxDB instance to query.
121121

122-
See [InfluxDB OSS URLs](/influxdb/latest/reference/urls/)
122+
See [InfluxDB OSS URLs](/influxdb/v2/reference/urls/)
123123
or [InfluxDB Cloud regions](/influxdb/cloud/reference/regions/).
124124

125125
### org
@@ -130,7 +130,7 @@ Organization name.
130130

131131
### token
132132

133-
InfluxDB [API token](/influxdb/latest/security/tokens/).
133+
InfluxDB [API token](/influxdb/v2/security/tokens/).
134134

135135

136136

content/flux/v0/stdlib/experimental/csv/from.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: csv.from() function
33
description: >
4-
`csv.from()` retrieves [annotated CSV](/influxdb/latest/reference/syntax/annotated-csv/) **from a URL**.
4+
`csv.from()` retrieves [annotated CSV](/influxdb/v2/reference/syntax/annotated-csv/) **from a URL**.
55
menu:
66
flux_v0_ref:
77
name: csv.from
@@ -26,7 +26,7 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md
2626
2727
------------------------------------------------------------------------------->
2828

29-
`csv.from()` retrieves [annotated CSV](/influxdb/latest/reference/syntax/annotated-csv/) **from a URL**.
29+
`csv.from()` retrieves [annotated CSV](/influxdb/v2/reference/syntax/annotated-csv/) **from a URL**.
3030

3131
{{% warn %}}
3232
#### Deprecated

content/flux/v0/stdlib/experimental/geo/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Geometry Library to generate `s2_cell_id` tags.
6363
Specify your [S2 Cell ID level](https://s2geometry.io/resources/s2cell_statistics.html).
6464

6565
**Note:** To filter more quickly, use higher S2 Cell ID levels, but know that
66-
higher levels increase [series cardinality](/influxdb/latest/reference/glossary/#series-cardinality).
66+
higher levels increase [series cardinality](/influxdb/v2/reference/glossary/#series-cardinality).
6767

6868
Language-specific implementations of the S2 Geometry Library provide methods for
6969
generating S2 Cell ID tokens. For example:

content/flux/v0/stdlib/experimental/prometheus/histogramquantile.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md
2929

3030
`prometheus.histogramQuantile()` calculates a quantile on a set of Prometheus histogram values.
3131

32-
This function supports [Prometheus metric parsing formats](/influxdb/latest/reference/prometheus-metrics/)
32+
This function supports [Prometheus metric parsing formats](/influxdb/v2/reference/prometheus-metrics/)
3333
used by `prometheus.scrape()`, the Telegraf `promtheus` input plugin, and
3434
InfluxDB scrapers available in InfluxDB OSS.
3535

@@ -53,7 +53,7 @@ Quantile to compute. Must be a float value between 0.0 and 1.0.
5353

5454
### metricVersion
5555

56-
[Prometheus metric parsing format](/influxdb/latest/reference/prometheus-metrics/)
56+
[Prometheus metric parsing format](/influxdb/v2/reference/prometheus-metrics/)
5757
used to parse queried Prometheus data.
5858
Available versions are `1` and `2`.
5959
Default is `2`.

0 commit comments

Comments
 (0)