|
1 |
| -# GitHub Copilot Instructions for InfluxData Documentation |
| 1 | +# Instructions for InfluxData Documentation |
2 | 2 |
|
3 | 3 | ## Purpose and scope
|
4 | 4 |
|
5 |
| -GitHub Copilot should help document InfluxData products by creating clear, accurate technical content with proper code examples, frontmatter, and formatting. |
| 5 | +Help document InfluxData products by creating clear, accurate technical content with proper code examples, frontmatter, and formatting. |
6 | 6 |
|
7 | 7 | ## Documentation structure
|
8 | 8 |
|
9 | 9 | - **Product version data**: `/data/products.yml`
|
10 |
| -- **Products**: |
| 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/ |
11 | 14 | - InfluxDB 3 Core
|
12 | 15 | - Documentation source path: `/content/influxdb3/core`
|
13 | 16 | - Published for the web: https://docs.influxdata.com/influxdb3/core/
|
@@ -92,7 +95,8 @@ GitHub Copilot should help document InfluxData products by creating clear, accur
|
92 | 95 |
|
93 | 96 | ## Markdown and shortcodes
|
94 | 97 |
|
95 |
| -- Include proper frontmatter for each page: |
| 98 | +- Include proper frontmatter for Markdown pages in `content/**/*.md` (except for |
| 99 | + shared content files in `content/shared/`): |
96 | 100 |
|
97 | 101 | ```yaml
|
98 | 102 | title: # Page title (h1)
|
@@ -180,3 +184,17 @@ Table: keys: [_start, _stop, _field, _measurement]
|
180 | 184 | ## Related repositories
|
181 | 185 |
|
182 | 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