Skip to content

Commit a06dd3c

Browse files
authored
Merge branch 'master' into clarify-IdP-support
2 parents 7d67507 + c035989 commit a06dd3c

File tree

2,208 files changed

+167427
-63605
lines changed

Some content is hidden

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

2,208 files changed

+167427
-63605
lines changed

.circleci/config.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: 2
1+
version: 2.1
22
jobs:
33
build:
44
docker:
@@ -31,17 +31,17 @@ jobs:
3131
command: cd api-docs && bash generate-api-docs.sh
3232
- run:
3333
name: Inject Flux stdlib frontmatter
34-
command: node ./flux-build-scripts/inject-flux-stdlib-frontmatter.js
34+
command: node ./flux-build-scripts/inject-flux-stdlib-frontmatter.cjs
3535
- run:
3636
name: Update Flux/InfluxDB versions
37-
command: node ./flux-build-scripts/update-flux-versions.js
37+
command: node ./flux-build-scripts/update-flux-versions.cjs
3838
- save_cache:
3939
key: install-{{ .Environment.CACHE_VERSION }}-{{ checksum ".circleci/config.yml" }}
4040
paths:
4141
- /home/circleci/bin
4242
- run:
4343
name: Hugo Build
44-
command: npx hugo --logLevel info --minify --destination workspace/public
44+
command: yarn hugo --environment production --logLevel info --gc --destination workspace/public
4545
- persist_to_workspace:
4646
root: workspace
4747
paths:
@@ -68,7 +68,6 @@ jobs:
6868
when: on_success
6969

7070
workflows:
71-
version: 2
7271
build:
7372
jobs:
7473
- build

.context/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Context Files for LLMs and AI Tools
2+
3+
This directory contains plans, reports, and other context files that are:
4+
- Used to provide context to LLMs during development
5+
- Not committed to the repository
6+
- May be transient or belong in other repositories
7+
8+
## Directory Structure
9+
10+
- `plans/` - Documentation plans and roadmaps
11+
- `reports/` - Generated reports and analyses
12+
- `research/` - Research notes and findings
13+
- `templates/` - Reusable templates for Claude interactions
14+
15+
## Usage
16+
17+
Place files here that you want to reference--for example, using @ mentions in Claude--such as:
18+
- Documentation planning documents
19+
- API migration guides
20+
- Performance reports
21+
- Architecture decisions
22+
23+
## Example Structure
24+
25+
```
26+
.context/
27+
├── plans/
28+
│ ├── v3.2-release-plan.md
29+
│ └── api-migration-guide.md
30+
├── reports/
31+
│ ├── weekly-progress-2025-07.md
32+
│ └── pr-summary-2025-06.md
33+
├── research/
34+
│ └── competitor-analysis.md
35+
└── templates/
36+
└── release-notes-template.md
37+
```
38+
39+
## Best Practices
40+
41+
1. Use descriptive filenames that indicate the content and date
42+
2. Keep files organized in appropriate subdirectories
43+
3. Consider using date prefixes for time-sensitive content (e.g., `2025-07-01-meeting-notes.md`)
44+
4. Remove outdated files periodically to keep the context relevant

.github/copilot-instructions.md

Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
# Instructions for InfluxData Documentation
2+
3+
## Purpose and scope
4+
5+
Help document InfluxData products by creating clear, accurate technical content with proper code examples, frontmatter, and formatting.
6+
7+
## Documentation structure
8+
9+
- **Product version data**: `/data/products.yml`
10+
- **InfluxData products**:
11+
- InfluxDB 3 Explorer
12+
- Documentation source path: `/content/influxdb3/explorer`
13+
- Published for the web: https://docs.influxdata.com/influxdb3/explorer/
14+
- InfluxDB 3 Core
15+
- Documentation source path: `/content/influxdb3/core`
16+
- Published for the web: https://docs.influxdata.com/influxdb3/core/
17+
- Code repositories: https://github.com/influxdata/influxdb, https://github.com/influxdata/influxdb3_core
18+
- InfluxDB 3 Enterprise
19+
- Documentation source path: `/content/influxdb3/enterprise`
20+
- Published for the web: https://docs.influxdata.com/influxdb3/enterprise/
21+
- Code repositories: https://github.com/influxdata/influxdb, https://github.com/influxdata/influxdb3_enterprise
22+
- InfluxDB Cloud Dedicated
23+
- Documentation source path: `/content/influxdb3/cloud-dedicated`
24+
- Published for the web: https://docs.influxdata.com/influxdb3/cloud-dedicated/
25+
- Code repository: https://github.com/influxdata/influxdb
26+
- InfluxDB Cloud Serverless
27+
- Documentation source path: `/content/influxdb3/cloud-serverless`
28+
- Published for the web: https://docs.influxdata.com/influxdb3/cloud-serverless/
29+
- Code repository: https://github.com/influxdata/idpe
30+
- InfluxDB Cloud v2 (TSM)
31+
- Documentation source path: `/content/influxdb/cloud`
32+
- Published for the web: https://docs.influxdata.com/influxdb/cloud/
33+
- Code repository: https://github.com/influxdata/idpe
34+
- InfluxDB Clustered
35+
- Documentation source path: `/content/influxdb3/clustered`
36+
- Published for the web: https://docs.influxdata.com/influxdb3/clustered/
37+
- Code repository: https://github.com/influxdata/influxdb
38+
- InfluxDB Enterprise v1 (1.x)
39+
- Documentation source path: `/content/influxdb/enterprise_influxdb`
40+
- Published for the web: https://docs.influxdata.com/enterprise_influxdb/v1/
41+
- Code repository: https://github.com/influxdata/influxdb
42+
- InfluxDB OSS 1.x
43+
- Documentation source path: `/content/influxdb/v1`
44+
- Published for the web: https://docs.influxdata.com/influxdb/v1/
45+
- Code repository: https://github.com/influxdata/influxdb
46+
- InfluxDB OSS 2.x
47+
- Documentation source path: `/content/influxdb/v2`
48+
- Published for the web: https://docs.influxdata.com/influxdb/v2/
49+
- Code repository: https://github.com/influxdata/influxdb
50+
- Telegraf
51+
- Documentation source path: `/content/telegraf/v1`
52+
- Published for the web: https://docs.influxdata.com/telegraf/v1/
53+
- Code repository: https://github.com/influxdata/telegraf
54+
- Kapacitor
55+
- Documentation source path: `/content/kapacitor/v1`
56+
- Published for the web: https://docs.influxdata.com/kapacitor/v1/
57+
- Code repository: https://github.com/influxdata/kapacitor
58+
- Chronograf
59+
- Documentation source path: `/content/chronograf/v1`
60+
- Published for the web: https://docs.influxdata.com/chronograf/v1/
61+
- Code repository: https://github.com/influxdata/chronograf
62+
- Flux
63+
- Documentation source path: `/content/flux/v0`
64+
- Published for the web: https://docs.influxdata.com/flux/v0/
65+
- Code repository: https://github.com/influxdata/flux
66+
- **InfluxData-supported tools**:
67+
- InfluxDB API client libraries
68+
- Code repositories: https://github.com/InfluxCommunity
69+
- InfluxDB 3 processing engine plugins
70+
- Code repository: https://github.com/influxdata/influxdb3_plugins
71+
- **Query Languages**: SQL, InfluxQL, Flux (use appropriate language per product version)
72+
- **Documentation Site**: https://docs.influxdata.com
73+
- **Repository**: https://github.com/influxdata/docs-v2
74+
- **Framework**: Hugo static site generator
75+
76+
## Style guidelines
77+
78+
- Follow Google Developer Documentation style guidelines
79+
- For API references, follow YouTube Data API style
80+
- Use semantic line feeds (one sentence per line)
81+
- Format code examples to fit within 80 characters
82+
- Command line examples:
83+
- Should be formatted as code blocks
84+
- Should use long options (e.g., `--option` instead of `-o`)
85+
- Use cURL for API examples
86+
- Format to fit within 80 characters
87+
- Should use `--data-urlencode` for query parameters
88+
- Should use `--header` for headers
89+
- Use only h2-h6 headings in content (h1 comes from frontmatter title properties)
90+
- Use sentence case for headings
91+
- Use GitHub callout syntax
92+
- Image naming: `project/version-context-description.png`
93+
- Use appropriate product names and versions consistently
94+
- Follow InfluxData vocabulary guidelines
95+
96+
## Markdown and shortcodes
97+
98+
- Include proper frontmatter for Markdown pages in `content/**/*.md` (except for
99+
shared content files in `content/shared/`):
100+
101+
```yaml
102+
title: # Page title (h1)
103+
seotitle: # SEO title
104+
list_title: # Title for article lists
105+
description: # SEO description
106+
menu:
107+
product_version:
108+
weight: # Page order (1-99, 101-199, etc.)
109+
```
110+
- Follow the shortcode examples in `content/example.md` and the documentation
111+
for docs-v2 contributors in `CONTRIBUTING.md`
112+
- Use provided shortcodes correctly:
113+
- Notes/warnings: `{{% note %}}`, `{{% warn %}}`
114+
- Product-specific: `{{% enterprise %}}`, `{{% cloud %}}`
115+
- Tabbed content: `{{< tabs-wrapper >}}`, `{{% tabs %}}`, `{{% tab-content %}}`
116+
- Tabbed content for code examples (without additional text): `{{< code-tabs-wrapper >}}`, `{{% code-tabs %}}`, `{{% code-tab-content %}}`
117+
- Version links: `{{< latest >}}`, `{{< latest-patch >}}`
118+
- API endpoints: `{{< api-endpoint >}}`
119+
- Required elements: `{{< req >}}`
120+
- Navigation: `{{< page-nav >}}`
121+
- Diagrams: `{{< diagram >}}`, `{{< filesystem-diagram >}}`
122+
123+
## Code examples and testing
124+
125+
- Provide complete, working examples with proper testing annotations:
126+
127+
```python
128+
print("Hello, world!")
129+
```
130+
131+
<!--pytest-codeblocks:expected-output-->
132+
133+
```
134+
Hello, world!
135+
```
136+
137+
- CLI command example:
138+
139+
```sh
140+
influx query 'from(bucket:"example") |> range(start:-1h)'
141+
```
142+
143+
<!--pytest-codeblocks:expected-output-->
144+
145+
```
146+
Table: keys: [_start, _stop, _field, _measurement]
147+
_start:time _stop:time _field:string _measurement:string _time:time _value:float
148+
------------------------------ ------------------------------ ---------------------- ---------------------- ------------------------------ ----------------------------
149+
```
150+
151+
- Include necessary environment variables
152+
- Show proper credential handling for authenticated commands
153+
154+
## API documentation
155+
156+
- `/api-docs` contains OpenAPI spec files used for API reference documentation
157+
- Follow OpenAPI specification patterns
158+
- Match REST API examples to current implementation
159+
- Include complete request/response examples
160+
- Document required headers and authentication
161+
162+
## Versioning and product differentiation
163+
164+
- Clearly distinguish between different InfluxDB versions (1.x, 2.x, 3.x)
165+
- Use correct terminology for each product variant
166+
- Apply appropriate UI descriptions and screenshots
167+
- Reference appropriate query language per version
168+
169+
## Development tools
170+
171+
- Vale.sh linter for style checking
172+
- Configuration file: `.vale.ini`
173+
- Docker for local development and testing
174+
- pytest and pytest-codeblocks for validating code examples
175+
- Use cypress for testing documentation UI and links
176+
- Prettier for code formatting
177+
- ESLint for JavaScript and TypeScript linting
178+
- Lefthook (NPM package) for managing pre-commit hooks for quality assurance
179+
180+
## Code style
181+
182+
- Use modern JavaScript (ES6+) syntax
183+
184+
## Related repositories
185+
186+
- **Internal documentation assistance requests**: https://github.com/influxdata/DAR/issues Documentation
187+
188+
## Additional instruction files
189+
190+
For specific workflows and content types, also refer to:
191+
192+
- **InfluxDB 3 code placeholders**: `.github/instructions/influxdb3-code-placeholders.instructions.md` - Guidelines for placeholder formatting, descriptions, and shortcode usage in InfluxDB 3 documentation
193+
- **Contributing guidelines**: `.github/instructions/contributing.instructions.md` - Detailed style guidelines, shortcode usage, frontmatter requirements, and development workflows
194+
- **Content-specific instructions**: Check `.github/instructions/` directory for specialized guidelines covering specific documentation patterns and requirements
195+
196+
## Integration with specialized instructions
197+
198+
When working on InfluxDB 3 documentation (Core/Enterprise), prioritize the placeholder guidelines from `influxdb3-code-placeholders.instructions.md`.
199+
200+
For general documentation structure, shortcodes, and development workflows, follow the comprehensive guidelines in `contributing.instructions.md`.

0 commit comments

Comments
 (0)