Commit Graph

18 Commits (copilot/add-http-api-examples)

Author SHA1 Message Date
Jason Stirnaman a32b566887
test(influxdb3): Improve InfluxDB 3 Core and Enterprise Docker services (#6750)
* test(influxdb3): Improve InfluxDB 3 Core and Enterprise Docker services

Improve Docker Compose services and initialization script for testing InfluxDB 3 Core and Enterprise endpoints.

compose.yaml changes:
- Add influxdb3-core service with per-worktree data isolation
- Add influxdb3-core-noauth service for endpoint testing without auth
- Add influxdb3-enterprise service with trial license configuration
- Fix env_file handling (use optional path, remove variable override)
- Add detailed usage comments for each service

New files:
- test/scripts/init-influxdb3.sh: Helper script to initialize services,
  create directories, and validate configuration

- Enterprise configuration uses shared data at ~/influxdata-docs/.influxdb3/
to persist license and data across worktrees.

- .claude/skills/influxdb3-test-setup/SKILL.md. It covers:

  1. Architecture overview - Shows the directory structure for shared vs per-worktree data
  2. Quick reference - Common commands table
  3. Setup workflows - Core only, Enterprise only, or both
  4. Worktree-specific databases - How to create isolated databases named after the worktree
  5. Test environment configuration - Setting up .env.test files for code block tests
  6. Troubleshooting - Common issues (license, auth, ports)
  7. Service comparison - Core vs Enterprise differences

  The skill references the init script but keeps database creation as a separate workflow step, allowing flexibility for different testing scenarios.

* docs(copilot): Document influxdb3-test-setup skill in Copilot instructions (#6751)

* Initial plan

* docs(copilot): Add influxdb3-test-setup skill documentation to instructions

- Add InfluxDB 3 Test Setup subsection under Testing section with quick reference commands
- Add Skills section under Specialized Instructions with all available skills
- Document influxdb3-test-setup skill alongside existing skills (cypress-e2e-testing, docs-cli-workflow, hugo-template-dev)
- Include links to skill files and brief descriptions for discoverability

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* chore(ci): Refactor InfluxDB 3 token handling to use JSON secrets

- Store Core and Enterprise tokens as JSON files with metadata
- Update SKILL.md instructions for jq-based token extraction
- Use Docker secrets for secure token mounting in compose.yaml
- Update init-influxdb3.sh to generate JSON token files
- Refactor compose.yaml to mount token files as secrets, not binds
- Standardize API examples and environment setup for new token format

* docs(influxdb3): Update token documentation for Docker Compose and CI/CD (#6756)

- Add 'description' field to offline admin token schema alongside 'expiry_millis'
- Add new section for Docker Compose with preconfigured admin tokens
- Document Docker secrets for secure token management
- Add CI/CD setup instructions using environment variables
- Standardize on INFLUXDB3_AUTH_TOKEN environment variable

Both 'description' and 'expiry_millis' are optional fields supported
by the InfluxDB 3 server when reading preconfigured token files.

* Revert "docs(influxdb3): Update token documentation for Docker Compose and CI…" (#6757)

This reverts commit 5c786ac2fd.

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
2026-01-20 17:17:36 -06:00
Jason Stirnaman 925a26e580
fix(cli): Make docs edit non-blocking and reorganize CLI code (#6721)
* REAL-WORLD TESTING ────────────────── BEFORE FIX: ───────────  Agent
runs: docs edit <url>  Editor spawns and blocks  Agent hangs for 30+
seconds  Workflow times out or fails  Manual intervention required

AFTER FIX: ──────────  Agent runs: docs edit <url>  Editor spawns
detached  CLI exits in <1 second  Agent continues processing 
Workflow completes successfully  No manual intervention needed

ISSUE #21:  RESOLVED ───────────────────────

The docs edit command now: • Works perfectly in automated workflows •
Doesn't hang AI agents or scripts • Exits immediately by default •
Supports blocking mode via --wait flag • Handles both URL formats •
Provides clear feedback • Has comprehensive documentation

DEPLOYMENT STATUS:  READY ────────────────────────────

All tests pass: ✓ Unit tests (7/7) ✓ CLI tests ✓ Real-world agent
workflow ✓ Coverage Gap issue processing ✓ URL format support ✓
Non-blocking verification ✓ Blocking mode verification

Scenario: AI agent processes GitHub Coverage Gap issues Issues: #6702,

Results: • Fetched issues from GitHub  • Used docs edit to locate files
 • Identified missing docs (Coverage Gaps)  • Found existing docs  •
No hangs, no timeouts  • Total time: 2 seconds for 3 issues 

* refactor(cli): move docs CLI to dedicated scripts/docs-cli directory

- Organize all CLI tools and tests in scripts/docs-cli/
- Update package.json bin and script paths
- Update setup-local-bin.js to point to new location
- Fix import paths in docs-edit.js and docs-create.js
- Update SKILL.md with new features (--wait, --editor, path support)
- Update ISSUE-21-FIX-README.md with new structure
- Add comprehensive README.md for docs-cli directory
- All tests passing, non-blocking behavior verified

Closes #21

* feat(cli): add non-blocking editor support to docs create

- Add --open flag to open created files in editor
- Add --wait flag for blocking mode (use with --open)
- Add --editor flag for explicit editor selection
- Uses same editor resolution and process management as docs edit
- Non-blocking by default to prevent agent hanging
- Update all documentation with new examples
- Maintains backwards compatibility (--open is optional)

This completes the non-blocking implementation across both
docs edit and docs create commands.

* docs: update Copilot instructions with complete CLI tool reference

- Add docs create --open to Quick Reference table
- Document both create and edit commands comprehensively
- Add editor configuration section (shared between commands)
- Update content.instructions.md with CLI workflow examples
- Add NON-BLOCKING-IMPLEMENTATION-COMPLETE.md summary document
- Clarify non-blocking behavior for AI agents

* chore: remove ephemeral documentation files

Remove temporary documentation files used during development:
- CLAUDE-docs-tooling-issue21.md
- IMPLEMENTATION-SUMMARY.md
- ISSUE-21-FIX-README.md
- NON-BLOCKING-IMPLEMENTATION-COMPLETE.md
- TEST-RESULTS.md

All relevant documentation has been integrated into:
- README.md
- scripts/docs-cli/README.md
- .github/copilot-instructions.md
- .github/instructions/content.instructions.md
- .claude/skills/docs-cli-workflow/SKILL.md

* Fix url-parser.js broken import by moving to shared library location (#6727)

* Initial plan

* refactor: move url-parser.js to shared library location and fix imports

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Update scripts/docs-cli/__tests__/process-manager.test.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update scripts/docs-cli/__tests__/editor-resolver.test.js

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-01-13 21:47:09 -06:00
Copilot 7a1ceb439f
Configure GitHub Copilot instructions and navigation system (#6628)
* Initial plan

* feat: enhance Copilot instructions with style guidelines and navigation

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* fix: correct .claude/agents link in INSTRUCTIONS.md

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* refactor: remove duplication and app-specific references from instructions

- Simplified INSTRUCTIONS.md from 118 to 76 lines by removing duplicate content
- Changed "Claude Desktop app" to "Claude with MCP" throughout
- Removed file pattern table (already in copilot-instructions.md)
- Removed specialist agents table (already in copilot-instructions.md)
- Removed general documentation table (already in copilot-instructions.md)
- INSTRUCTIONS.md now serves as simple navigation guide without duplication

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* Update README.md

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-12-15 12:43:34 -06:00
Jason Stirnaman 189d86fcda chore(instructions): restructure contributing instructions for humans and assistants 2025-10-08 15:48:44 -05:00
Jason Stirnaman 3e4864a836 Instructions files cleanup:
- Follow Copilot guidelines for naming instructions files according to the directory they apply to
- Copy instructions files as CLAUDE.md to the relevant directory.
- Update placeholder instructions
- Optimize Copilot instructions
- Remove Claude instructions and reference the Copilot instructions file instead

TODO: update the commit hook script to correctly generate and place the files.
2025-09-23 10:37:10 -05:00
Jason Stirnaman 92210137b2 chore(qol): Make agents more collaborative and not automatically agreeable. 2025-08-19 09:54:10 -05:00
Jason Stirnaman 3b5385812a
Apply suggestions from code review 2025-08-15 10:14:29 -05:00
copilot-swe-agent[bot] 97c02baf20 Complete comprehensive GitHub Copilot instructions with validated build and test processes
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
2025-08-13 14:40:54 +00:00
Jason Stirnaman b20401bed4 chore(qol): Add Claude command to enhance the release notes generated by generate-release-notes.js.claude/commands/enhance-release-notes.md file
that provides Claude with detailed instructions
  for enhancing release notes.
The command includes specific transformation
  patterns for different components (database, CLI,
  API, etc.) and provides fallback templates for
  handling edge cases. It also includes error
  handling for common issues like rate limits and
  private repositories.
2025-07-07 12:13:37 -05:00
Jason Stirnaman 38b08ecc51 chore(qol): Add claude instructions file for the project
The CLAUDE.md file successfully references 5 key files, all of which exist and are accessible:

  1. @README → README.md - Project overview and setup
  2. @package.json → package.json - NPM scripts and dependencies
  3. @.github/copilot-instructions.md → Main style guidelines and product info
  4. @.github/instructions/contributing.instructions.md → Detailed contributing guide
  5. @.github/instructions/influxdb3-code-placeholders.instructions.md → InfluxDB 3 specific
  guidelines

  📊 Current Structure Analysis

  The CLAUDE.md file acts as a minimal index that:
  - Delegates detailed instructions to other files
  - Uses Claude's @ symbol notation for file references
  - Provides a clear hierarchy of information

  💡 Key Instructions Coverage

  Through the linked files, Claude has access to:
  - Product documentation paths for all InfluxDB versions
  - Style guidelines following Google Developer Documentation standards
  - Shortcode usage with extensive examples
  - Testing procedures including pytest-codeblocks
  - Development workflows with Docker and Node.js
  - Placeholder conventions for code examples
  - Frontmatter requirements for Hugo pages
2025-06-25 14:46:18 -05:00
Jason Stirnaman 70cd745419 feat(cloud-dedicated): Admin UI: Account info, manage clusters, manage databases, manage tables, manage tokens. (Closes #6023)
- Admin UI: console URL
- Admin UI: add management features to existing admin pages
- Add a View account page for Admin UI
- Add screenshots
- Add Admin UI page to reference
- Alias reference/cli to influxctl until we expect more.
- Add key features list to influxctl reference

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-05-06 14:05:12 -05:00
Jason Stirnaman c069ee74c3 chore(copilot): Update instructions. 2025-05-01 13:47:22 -05:00
Jason Stirnaman 68fea9828c chore(docs): Add documentation for code-placeholders and code-placeholder-key shortcodes. Instruct CoPilot to use CONTRIBUTING.md. 2025-04-21 09:57:26 -05:00
Jason Stirnaman 8bd5e92ada chore(copilot): add InfluxDB 3 Enterprise to products list 2025-04-03 11:51:16 -05:00
Jason Stirnaman 46c5061669 chore(ci): copilot-instructions 2025-03-21 17:41:50 -05:00
Jason Stirnaman e8dcb1c71a chore(ci): copilot-instructions: product version data 2025-03-21 11:24:37 -05:00
Jason Stirnaman 3d3de0fab0 chore(ci): copilot-instructions: specify content paths, related repositories, and additional guidelines 2025-03-21 11:21:36 -05:00
Jason Stirnaman a0dfc1c9be chore(ci): Add copilot custom instructions file based on DOC_GPT_PROFILE.md and CONTRIBUTING.md. 2025-03-21 10:15:39 -05:00