Skip to content

Commit a85eb32

Browse files
authored
Merge pull request #6140 from influxdata/monolith-gs-restructure
Restructure Core/Enterprise getting started docs
2 parents 9289949 + c5c6663 commit a85eb32

File tree

64 files changed

+3165
-2331
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+3165
-2331
lines changed

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ node_modules
1515
!telegraf-build/templates
1616
!telegraf-build/scripts
1717
!telegraf-build/README.md
18-
/cypress/downloads
18+
/cypress/downloads/*
1919
/cypress/screenshots/*
2020
/cypress/videos/*
2121
test-results.xml
@@ -25,4 +25,4 @@ test-results.xml
2525
.idea
2626
**/config.toml
2727
package-lock.json
28-
tmp
28+
tmp

content/influxdb3/clustered/reference/release-notes/clustered.md

Lines changed: 5 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -250,8 +250,8 @@ spec:
250250

251251
#### Release artifacts
252252

253-
- [app-instance-schema.json](/downloads/clustered-release-artifacts/20241022-1346953/app-instance-schema.json)
254-
- [example-customer.yml](/downloads/clustered-release-artifacts/20241022-1346953/example-customer.yml)
253+
- [app-instance-schema.json](/downloads/clustered-release-artifacts/20241024-1354148/app-instance-schema.json)
254+
- [example-customer.yml](/downloads/clustered-release-artifacts/20241024-1354148/example-customer.yml)
255255
- [InfluxDB Clustered README EULA July 2024.txt](/downloads/clustered-release-artifacts/InfluxDB%20Clustered%20README%20EULA%20July%202024.txt)
256256

257257
### Known Bugs
@@ -804,13 +804,13 @@ version of `influxctl` prior to v2.8.0.
804804
```yaml
805805
spec:
806806
package:
807-
image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:20240325-920726
807+
image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:20240326-922145
808808
```
809809

810810
#### Release artifacts
811811

812-
- [app-instance-schema.json](/downloads/clustered-release-artifacts/20240325-920726/app-instance-schema.json)
813-
- [example-customer.yml](/downloads/clustered-release-artifacts/20240325-920726/example-customer.yml)
812+
- [app-instance-schema.json](/downloads/clustered-release-artifacts/20240326-922145/app-instance-schema.json)
813+
- [example-customer.yml](/downloads/clustered-release-artifacts/20240326-922145/example-customer.yml)
814814
- [InfluxDB Clustered README EULA July 2024.txt](/downloads/clustered-release-artifacts/InfluxDB%20Clustered%20README%20EULA%20July%202024.txt)
815815

816816
### Highlights
@@ -1424,12 +1424,6 @@ spec:
14241424
image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:20230915-630658
14251425
```
14261426

1427-
#### Release artifacts
1428-
1429-
- [app-instance-schema.json](/downloads/clustered-release-artifacts/20230915-630658/app-instance-schema.json)
1430-
- [example-customer.yml](/downloads/clustered-release-artifacts/20230915-630658/example-customer.yml)
1431-
- [InfluxDB Clustered README EULA July 2024.txt](/downloads/clustered-release-artifacts/InfluxDB%20Clustered%20README%20EULA%20July%202024.txt)
1432-
14331427
### Highlights
14341428

14351429
#### Persistent volume fixes
@@ -1456,12 +1450,6 @@ spec:
14561450
image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:20230914-628600
14571451
```
14581452

1459-
#### Release artifacts
1460-
1461-
- [app-instance-schema.json](/downloads/clustered-release-artifacts/20230914-628600/app-instance-schema.json)
1462-
- [example-customer.yml](/downloads/clustered-release-artifacts/20230914-628600/example-customer.yml)
1463-
- [InfluxDB Clustered README EULA July 2024.txt](/downloads/clustered-release-artifacts/InfluxDB%20Clustered%20README%20EULA%20July%202024.txt)
1464-
14651453
### Highlights
14661454

14671455
#### Updated Azure AD documentation
@@ -1497,12 +1485,6 @@ spec:
14971485
image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:20230912-619813
14981486
```
14991487

1500-
#### Release artifacts
1501-
1502-
- [app-instance-schema.json](/downloads/clustered-release-artifacts/20230912-619813/app-instance-schema.json)
1503-
- [example-customer.yml](/downloads/clustered-release-artifacts/20230912-619813/example-customer.yml)
1504-
- [InfluxDB Clustered README EULA July 2024.txt](/downloads/clustered-release-artifacts/InfluxDB%20Clustered%20README%20EULA%20July%202024.txt)
1505-
15061488
### Highlights
15071489

15081490
#### Custom CA certificates {note="(Optional)"}
@@ -1573,12 +1555,6 @@ spec:
15731555
image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:20230911-604209
15741556
```
15751557

1576-
#### Release artifacts
1577-
1578-
- [app-instance-schema.json](/downloads/clustered-release-artifacts/20230911-604209/app-instance-schema.json)
1579-
- [example-customer.yml](/downloads/clustered-release-artifacts/20230911-604209/example-customer.yml)
1580-
- [InfluxDB Clustered README EULA July 2024.txt](/downloads/clustered-release-artifacts/InfluxDB%20Clustered%20README%20EULA%20July%202024.txt)
1581-
15821558
### Highlights
15831559

15841560
This release contains a breaking change to the monitoring subsystem that
@@ -1628,12 +1604,6 @@ spec:
16281604
image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:20230908-600131
16291605
```
16301606

1631-
#### Release artifacts
1632-
1633-
- [app-instance-schema.json](/downloads/clustered-release-artifacts/20230908-600131/app-instance-schema.json)
1634-
- [example-customer.yml](/downloads/clustered-release-artifacts/20230908-600131/example-customer.yml)
1635-
- [InfluxDB Clustered README EULA July 2024.txt](/downloads/clustered-release-artifacts/InfluxDB%20Clustered%20README%20EULA%20July%202024.txt)
1636-
16371607
### Highlights
16381608

16391609
#### Default storage class
@@ -1661,12 +1631,6 @@ spec:
16611631
image: us-docker.pkg.dev/influxdb2-artifacts/clustered/influxdb:20230907-597343
16621632
```
16631633

1664-
#### Release artifacts
1665-
1666-
- [app-instance-schema.json](/downloads/clustered-release-artifacts/20230907-597343/app-instance-schema.json)
1667-
- [example-customer.yml](/downloads/clustered-release-artifacts/20230907-597343/example-customer.yml)
1668-
- [InfluxDB Clustered README EULA July 2024.txt](/downloads/clustered-release-artifacts/InfluxDB%20Clustered%20README%20EULA%20July%202024.txt)
1669-
16701634
### Upgrade Notes
16711635

16721636
This release requires a new configuration block:
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Process data in {{% product-name %}}
3+
seotitle: Process data | Get started with {{% product-name %}}
4+
description: >
5+
Learn how to use the {{% product-name %}} Processing Engine to process data and
6+
perform various tasks like downsampling, alerting, forecasting, data
7+
normalization, and more.
8+
menu:
9+
influxdb3_core:
10+
name: Process data
11+
identifier: gs-process-data
12+
parent: Get started
13+
weight: 104
14+
aliases:
15+
- /influxdb3/core/get-started/process-data/
16+
- /influxdb3/core/get-started/processing-engine/
17+
related:
18+
- /influxdb3/core/plugins/
19+
- /influxdb3/core/reference/cli/influxdb3/create/plugin/
20+
- /influxdb3/core/reference/cli/influxdb3/create/trigger/
21+
source: /shared/influxdb3-get-started/processing-engine.md
22+
---
23+
24+
<!--
25+
The content of this page is at
26+
// SOURCE content/shared/influxdb3-get-started/query.md
27+
-->
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Query data in {{% product-name %}}
3+
seotitle: Query data | Get started with {{% product-name %}}
4+
description: >
5+
Learn how to get started querying data in {{% product-name %}} using native
6+
SQL or InfluxQL with the `influxdb3` CLI and other tools.
7+
menu:
8+
influxdb3_core:
9+
name: Query data
10+
identifier: gs-query-data
11+
parent: Get started
12+
weight: 103
13+
related:
14+
- /influxdb3/core/query-data/
15+
- /influxdb3/core/reference/sql/
16+
- https://datafusion.apache.org/user-guide/sql/index.html, Apache DataFusion SQL reference
17+
- /influxdb3/core/reference/influxql/
18+
source: /shared/influxdb3-get-started/query.md
19+
---
20+
21+
<!--
22+
The content of this page is at
23+
// SOURCE content/shared/influxdb3-get-started/query.md
24+
-->
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Set up {{% product-name %}}
3+
seotitle: Set up InfluxDB | Get started with {{% product-name %}}
4+
description: >
5+
Install, configure, and set up authorization for {{% product-name %}}.
6+
menu:
7+
influxdb3_core:
8+
name: Set up Core
9+
parent: Get started
10+
weight: 3
11+
related:
12+
- /influxdb3/core/install/
13+
- /influxdb3/core/admin/tokens/
14+
- /influxdb3/core/reference/config-options/
15+
source: /shared/influxdb3-get-started/setup.md
16+
---
17+
18+
<!--
19+
The content of this page is at
20+
// SOURCE content/shared/influxdb3-get-started/setup.md
21+
-->
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Write data to {{% product-name %}}
3+
seotitle: Write data | Get started with {{% product-name %}}
4+
description: >
5+
Learn how to write time series data to {{% product-name %}} using the
6+
`influxdb3` CLI and _line protocol_, an efficient, human-readable write syntax.
7+
menu:
8+
influxdb3_core:
9+
name: Write data
10+
identifier: gs-write-data
11+
parent: Get started
12+
weight: 102
13+
related:
14+
- /influxdb3/core/write-data/
15+
- /influxdb3/core/reference/line-protocol/
16+
source: /shared/influxdb3-get-started/write.md
17+
---
18+
19+
<!--
20+
The content of this page is at
21+
// SOURCE content/shared/influxdb3-get-started/write.md
22+
-->

content/influxdb3/core/reference/cli/influxdb3/create/file_index.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

content/influxdb3/core/reference/cli/influxdb3/delete/file_index.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

content/influxdb3/core/write-data/api-client-libraries.md renamed to content/influxdb3/core/write-data/client-libraries.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
title: Use the HTTP API and client libraries to write data
2+
title: Use InfluxDB client libraries to write data
33
description: >
4-
Use the `/api/v3/write_lp` HTTP API endpoint and InfluxDB API clients to write points as line protocol data to {{% product-name %}}.
4+
Use InfluxDB API clients to write points as line protocol data to {{% product-name %}}.
55
menu:
66
influxdb3_core:
7-
name: Use the API and client libraries
7+
name: Use client libraries
88
parent: Write data
9-
identifier: write-api-client-libs
9+
identifier: write-client-libs
1010
weight: 100
1111
aliases:
12-
- /influxdb3/core/write-data/client-libraries/
12+
- /influxdb3/core/write-data/api-client-libraries/
1313
related:
1414
- /influxdb3/core/reference/syntax/line-protocol/
1515
- /influxdb3/core/get-started/write/
1616
- /influxdb3/core/reference/client-libraries/v3/
1717
- /influxdb3/core/api/v3/#operation/PostWriteLP, /api/v3/write_lp endpoint
18-
source: /shared/influxdb3-write-guides/api-client-libraries.md
18+
source: /shared/influxdb3-write-guides/client-libraries.md
1919
---
2020

2121
<!--
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Use the InfluxDB HTTP API to write data
3+
description: >
4+
Use the `/api/v3/write_lp`, `/api/v2/write`, or `/write` HTTP API endpoints
5+
to write data to {{% product-name %}}.
6+
menu:
7+
influxdb3_core:
8+
name: Use the HTTP API
9+
parent: Write data
10+
identifier: write-http-api
11+
weight: 100
12+
related:
13+
- /influxdb3/core/reference/syntax/line-protocol/
14+
- /influxdb3/core/get-started/write/
15+
- /influxdb3/core/api/v3/#operation/PostWriteLP, /api/v3/write_lp endpoint
16+
source: /shared/influxdb3-write-guides/http-api/_index.md
17+
---
18+
19+
<!--
20+
The content for this page is at
21+
// SOURCE content/shared/influxdb3-write-guides/http-api/_index.md
22+
-->

0 commit comments

Comments
 (0)