Skip to content

Add URL aliases for Docker Hub links to influxdb3 serve documentation#6895

Merged
jstirnaman merged 8 commits intomasterfrom
copilot/fix-broken-docker-link
Mar 26, 2026
Merged

Add URL aliases for Docker Hub links to influxdb3 serve documentation#6895
jstirnaman merged 8 commits intomasterfrom
copilot/fix-broken-docker-link

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 2, 2026

Content fix

Docker Hub links to /influxdb3/{core,enterprise}/reference/clis/influxdb3/serve/ (plural) but documentation uses /cli/ (singular), resulting in 404s.

Changes

Added Hugo aliases frontmatter to redirect legacy plural URLs to current singular paths:

  • content/influxdb3/core/reference/cli/influxdb3/serve.md

    • Alias: /influxdb3/core/reference/clis/influxdb3/serve//influxdb3/core/reference/cli/influxdb3/serve/
  • content/influxdb3/enterprise/reference/cli/influxdb3/serve.md

    • Alias: /influxdb3/enterprise/reference/clis/influxdb3/serve//influxdb3/enterprise/reference/cli/influxdb3/serve/

Hugo generates meta refresh redirects at alias URLs automatically.

CI Improvement

The copilot-visual-review job posted a PR comment mentioning @github-copilot, which never invokes Copilot Vision and produces no entry in the Checks tab—a silent no-op that implied review was happening when it wasn't.
The new workflow creates an action that invokes Copilot to do the visual review and report the check status.

Changes

doc-review.yml — Job 3 (copilot-visual-review)

  • Drop pull-requests: write; add checks: write
  • Create an in_progress check run via checks.create at job start (immediately visible in Checks tab)
  • On preview available: complete with conclusion: neutral, output contains linked page list + full checklist from .github/prompts/copilot-visual-review.md
  • On timeout: complete with conclusion: neutral and re-run instructions
  • Remove all PR comment logic (including the @github-copilot mention)

doc-review.yml — Job 4 (report-skipped)

  • Drop pull-requests: write; add checks: write
  • Replace PR comment with checks.create at conclusion: skipped, explaining why no pages were reviewed

DOC-REVIEW-PIPELINE-PLAN.md / LABEL_GUIDE.md

  • Update section 2.4, 2.6, Q1 decision record, ASCII diagram, and pipeline step descriptions to reflect check-run-based approach
# Before: job posted a PR comment (no Checks entry, no Copilot action triggered)
- name: Post visual review request
  uses: actions/github-script@...
  with:
    script: |
      # ... upserts comment body containing @github-copilot mention

# After: creates an explicit Check Run visible in the Checks tab
- name: Create in-progress check run
  id: create-check
  uses: actions/github-script@...
  with:
    script: |
      const { data: check } = await github.rest.checks.create({
        name: 'Visual Review',
        head_sha: process.env.HEAD_SHA,
        status: 'in_progress',
        ...
      });

- name: Complete check run — preview available
  uses: actions/github-script@...
  with:
    script: |
      await github.rest.checks.update({
        check_run_id: checkRunId,
        status: 'completed',
        conclusion: 'neutral',   // awaiting human review
        output: { title, summary, text: pageList + checklist },
      });

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix broken link to server options in Docker Hub Add URL aliases for Docker Hub links to influxdb3 serve documentation Mar 2, 2026
@jstirnaman jstirnaman marked this pull request as ready for review March 2, 2026 22:57
@jstirnaman jstirnaman requested a review from a team as a code owner March 2, 2026 22:57
@jstirnaman jstirnaman requested review from sanderson and removed request for a team March 2, 2026 22:57
@github-actions github-actions bot added the product:v3-monolith InfluxDB 3 Core and Enterprise (single-node / clusterable) label Mar 22, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 22, 2026

PR Preview Action v1.4.8
🚀 Deployed preview to https://influxdata.github.io/docs-v2/pr-preview/pr-6895/
on branch gh-pages at 2026-03-26 21:02 UTC

@github-actions

This comment has been minimized.

* Initial plan

* Improve PR review workflow status signals and add agent personas

- Add Job 4 (report-skipped) to explicitly report when visual review is skipped
- Update resolve-review-urls.js to output skip status and reason
- Add clear agent persona headers to all bot comments (Preview Bot, Doc Review Bot)
- Reduce URL duplication by having visual review reference PR Preview comment
- Update copilot-visual-review.md template with completion signal format
- Add consistent status tables with emojis for clear at-a-glance status

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

* Address code review feedback

- Remove unnecessary comment about fallback default in resolve-review-urls.js
- Use plain text sanitization for skip reasons in preview comments
- Add clarifying comment about string comparison in GitHub Actions outputs

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>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
@jstirnaman jstirnaman added the agent-ready Agent can work on this autonomously label Mar 22, 2026
@jstirnaman jstirnaman requested a review from Copilot March 22, 2026 12:10
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR addresses broken inbound links from Docker Hub by adding Hugo frontmatter aliases so legacy plural /clis/ URLs redirect to the current singular /cli/ documentation paths, and also includes updates to the PR preview / doc review GitHub Actions comments and supporting scripts.

Changes:

  • Add Hugo aliases frontmatter to the InfluxDB 3 Core and Enterprise influxdb3 serve CLI reference pages to redirect /reference/clis/.../reference/cli/....
  • Enhance .github/workflows/doc-review.yml to surface “skipped”/“timeout” visual review states and post a dedicated “skipped” notice when no URLs are detected.
  • Update PR preview / visual review bot comment formatting and templates for clearer status reporting.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
content/influxdb3/core/reference/cli/influxdb3/serve.md Adds aliases to redirect the legacy plural /clis/ URL to the current page.
content/influxdb3/enterprise/reference/cli/influxdb3/serve.md Adds aliases to redirect the legacy plural /clis/ URL to the current page.
.github/workflows/pr-preview.yml Updates the fork-preview “not available” comment to a new status/table format with timestamp.
.github/workflows/doc-review.yml Adds skip-related outputs, reworks the visual review request comment, and adds a new “report-skipped” job.
.github/scripts/resolve-review-urls.js Emits skipped and skip-reason outputs when no previewable URLs are detected.
.github/scripts/preview-comment.js Reformats preview status comments (success/pending/failed/skipped) into a consistent status-table layout.
.github/prompts/copilot-visual-review.md Replaces the prior “Output” section with a stricter required response format/checklist structure.

Comment thread .github/workflows/doc-review.yml
jstirnaman and others added 3 commits March 26, 2026 14:50
… visual review (#6974) (#6975)

* Initial plan

* Improve PR review workflow status signals and add agent personas

- Add Job 4 (report-skipped) to explicitly report when visual review is skipped
- Update resolve-review-urls.js to output skip status and reason
- Add clear agent persona headers to all bot comments (Preview Bot, Doc Review Bot)
- Reduce URL duplication by having visual review reference PR Preview comment
- Update copilot-visual-review.md template with completion signal format
- Add consistent status tables with emojis for clear at-a-glance status

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

* Address code review feedback

- Remove unnecessary comment about fallback default in resolve-review-urls.js
- Use plain text sanitization for skip reasons in preview comments
- Add clarifying comment about string comparison in GitHub Actions outputs

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

* doc-review: replace @github-copilot comment with GitHub Check Run for visual review (#6974)

* Initial plan

* Redesign visual review: replace @github-copilot comment with GitHub Check Run

- Replace PR comment mentioning @github-copilot (which never triggered
  Copilot Vision) with GitHub Check Run via checks.create/checks.update
- Add checks: write permission to Jobs 3 and 4; downgrade pull-requests
  to read-only (no more PR comment writes needed)
- Job 3 (copilot-visual-review): create in-progress check, wait for
  preview, complete as neutral with URLs+checklist or timeout message
- Job 4 (report-skipped): create a skipped check run instead of a comment
- Update DOC-REVIEW-PIPELINE-PLAN.md and LABEL_GUIDE.md to match

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Agent-Logs-Url: https://github.com/influxdata/docs-v2/sessions/ef35b1d0-87cf-4b4f-92df-fff980a423c6

---------

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

* resolve conflicts: merge copilot/fix-broken-docker-link into copilot/resolve-conflicts (#6976)

* Initial plan

* Add aliases to fix broken Docker Hub links to serve documentation

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

* fix(influxdb3): correct broken links causing 404s (#6958)

- Fix Power BI links in visualization-tools.md for cloud-dedicated,
  cloud-serverless, and clustered to use new visualize-data/ path
  instead of old process-data/visualize/ path
- Fix influxctl cluster list link in cloud-dedicated/admin/clusters/list.md
  to include missing cluster/ path segment

https://claude.ai/code/session_01SV14CdHN4GGVuATt9n7STn

Co-authored-by: Claude <noreply@anthropic.com>

* fix(influxdb3): backfill missing product URLs in localStorage (#6961)

* fix(influxdb3): backfill missing product URLs in localStorage

Returning visitors with stale localStorage (created before core/enterprise
products were added) had undefined URL values for new products. The
updateUrls() function then replaced Hugo-rendered hostnames like
localhost:8181 with the string "undefined" in api-endpoint blocks.

Fix by merging DEFAULT_STORAGE_URLS as fallbacks when reading from
localStorage, so new product keys are always present.

closes #6960

https://claude.ai/code/session_01GJZ2yMR5DBk1feqTD5LeHW

* test(influxdb3): add Cypress tests for localStorage URL backfill

Adds 2 E2E tests for the fix in #6960:

1. Stale localStorage (missing `core` key) should not cause "undefined"
   to appear in api-endpoint or code blocks on the plugins page.
2. Fresh localStorage should be initialized with all expected product
   URL keys (oss, cloud, core, enterprise, serverless, dedicated, clustered).

Run with:
  node cypress/support/run-e2e-specs.js --spec "cypress/e2e/influxdb-url.cy.js" --no-mapping

https://claude.ai/code/session_01GJZ2yMR5DBk1feqTD5LeHW

---------

Co-authored-by: Claude <noreply@anthropic.com>

* Remove `>` CLI prompts from runnable code blocks in InfluxQL/Flux/MongoDB docs (#6948)

* Initial plan

* fix(docs): remove > prompt from runnable code blocks

Remove leading `>` CLI prompt characters from code blocks that are meant
to be executed by users. Only keep `>` in code blocks that demonstrate
console output (showing both the command at the prompt AND the result output).

Changes affect 34 files across InfluxDB v1, Enterprise InfluxDB, shared
influxql-v3 reference, and Telegraf content:
- InfluxQL queries and management commands (sql/bash/no-lang blocks)
- Flux REPL examples (js blocks)
- MongoDB shell commands (shell blocks)

Preserved (unchanged):
- Console session blocks showing command + output (Type B: mixed > and non-> lines)
- Telegraf metric output blocks (text language with > measurement,tags format)
- diff blocks with < and > diff markers

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

* Apply suggestions from code review

* Potential fix for pull request finding

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

* Apply suggestions from code review

* Potential fix for pull request finding

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

* Update content/enterprise_influxdb/v1/query_language/continuous_queries.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>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Add agentic workflow daily-repo-status (#6963)

* PR workflow: Improve review status signals and reduce noise (#6938)

* Initial plan

* Improve PR review workflow status signals and add agent personas

- Add Job 4 (report-skipped) to explicitly report when visual review is skipped
- Update resolve-review-urls.js to output skip status and reason
- Add clear agent persona headers to all bot comments (Preview Bot, Doc Review Bot)
- Reduce URL duplication by having visual review reference PR Preview comment
- Update copilot-visual-review.md template with completion signal format
- Add consistent status tables with emojis for clear at-a-glance status

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

* Address code review feedback

- Remove unnecessary comment about fallback default in resolve-review-urls.js
- Use plain text sanitization for skip reasons in preview comments
- Add clarifying comment about string comparison in GitHub Actions outputs

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>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* Initial plan

---------

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>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

* Initial plan (#6977)

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

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment thread .github/workflows/doc-review.yml Outdated
@jstirnaman jstirnaman merged commit d8dedeb into master Mar 26, 2026
12 checks passed
@jstirnaman jstirnaman deleted the copilot/fix-broken-docker-link branch March 26, 2026 21:10
github-actions bot added a commit that referenced this pull request Mar 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent-ready Agent can work on this autonomously product:v3-monolith InfluxDB 3 Core and Enterprise (single-node / clusterable)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants