Skip to content

[Version Management] Update API limitation, fix troubleshooting page, add code owner#31804

Merged
ngayerie merged 3 commits into
productionfrom
ngayerie/version-management-api-limitation
Jun 30, 2026
Merged

[Version Management] Update API limitation, fix troubleshooting page, add code owner#31804
ngayerie merged 3 commits into
productionfrom
ngayerie/version-management-api-limitation

Conversation

@ngayerie

@ngayerie ngayerie commented Jun 30, 2026

Copy link
Copy Markdown
Collaborator

Summary

Update the Version Management documentation to reflect that the public Environments API is available, and add @jhutchings1 as code owner for the version-management partials.

Changes

Topic File Change
Environments API partials/version-management/product-limitations.mdx Document that Version Management environments can be managed through the public Environments API; clarify that creating, cloning, and editing zone versions remains dashboard-only
Troubleshooting docs/version-management/troubleshooting.mdx Remove outdated claims that no public API exists and that the 10001 error is expected behavior; keep the Terraform mutual-exclusion guidance under a renamed section
CODEOWNERS .github/CODEOWNERS Add @jhutchings1 as code owner for /src/content/partials/version-management/

Replaces #31525.

@github-actions

github-actions Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/.github/CODEOWNERS @cloudflare/product-owners, @cloudflare/content-engineering, @kodster28
/src/content/docs/version-management/ @jhutchings1, @cloudflare/product-owners
/src/content/partials/version-management/ @jhutchings1, @cloudflare/product-owners

@ask-bonk ask-bonk Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review summary

Changes

  • CODEOWNERS: Adds @jhutchings1 @cloudflare/product-owners for /src/content/partials/version-management/. This is consistent with the existing docs path and is a sensible addition.
  • Product limitations partial: Updates the Cloudflare API section to reflect that environments can now be managed via the public Environments API, while maintaining that version snapshot operations remain dashboard-only.

Verification

  • ✅ The internal link /api/resources/zones/subresources/environments/ resolves correctly on the live site.
  • ✅ Frontmatter and component import are correctly structured for a partial.
  • ✅ PR title follows the [Product] description convention.

Flags

  • Inline comment posted on a subject-verb agreement issue in the new dashboard-only bullet ("is" → "are").
  • The Build check is still pending; assuming it passes, this change is straightforward.

Labels

size/xs is already applied and appropriate.

@ask-bonk

ask-bonk Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Review completed for PR #31804

Summary of changes

  1. CODEOWNERS — Added @jhutchings1 @cloudflare/product-owners as code owners for /src/content/partials/version-management/. This mirrors the existing ownership for the docs path and is a sensible, consistent change.
  2. Product limitations partial — Updated the "Cloudflare API" <Details> section to state that Version Management environments can now be managed via the public Environments API (/api/resources/zones/subresources/environments/), while clarifying that creating, cloning, and editing zone versions remains dashboard-only.

Labels applied

  • Added product:version-management (the size/xs label was already present).

Issues flagged

  • Grammar / subject-verb agreement in src/content/partials/version-management/product-limitations.mdx line 54:

    "Creating, cloning, and editing zone versions … is currently only available …"

    The compound subject ("Creating, cloning, and editing zone versions") should take a plural verb: "are".

  • Build check is still pending. The new internal link resolves correctly on the live site, so no broken links are expected.

Verification

  • ✅ Link /api/resources/zones/subresources/environments/ verified live and valid.
  • ✅ Frontmatter and component import structure are correct for a partial.
  • ✅ PR title follows the [Product] description convention.
  • ✅ CODEOWNERS change is consistent with adjacent entries.

I posted a review comment on the PR detailing these findings. Note: I was unable to post an inline review comment via the available GitHub API in this environment, so the grammar flag is included in the main review body instead.

github run

@github-actions

github-actions Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

ngayerie added 2 commits June 30, 2026 13:14
- Document that Version Management environments can be managed through
  the public Environments API. Only the creation, cloning, and editing
  of zone versions themselves remain dashboard-only.
- Add @jhutchings1 as code owner for /src/content/partials/version-management/.

Replaces PR #31525 (originally opened by external contributor
@Techsurfer1981, SFSC case 02109410).
@ngayerie

Copy link
Copy Markdown
Collaborator Author

@Techsurfer1981 here is the new PR

- Remove the claim that Version Management does not expose a public API:
  the Environments API is now public.
- Remove the '10001 authentication error is expected behavior' paragraph:
  no longer accurate now that the API is available.
- Keep the Terraform mutual-exclusion guidance under a renamed section.
@ngayerie ngayerie force-pushed the ngayerie/version-management-api-limitation branch from ccb451d to dcf481d Compare June 30, 2026 13:16
@ngayerie ngayerie changed the title [Version Management] Update API limitation and add code owner [Version Management] Update API limitation, fix troubleshooting page, add code owner Jun 30, 2026
@ngayerie ngayerie marked this pull request as ready for review June 30, 2026 14:04
@ngayerie ngayerie requested review from a team, jhutchings1 and kodster28 as code owners June 30, 2026 14:04
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Review

💡 1 suggestion found in commit dcf481d.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

No code review issues found.

Conventions

Checks PR title, description, and redirect checklist.

No convention issues found.

Style Guide Review

Suggestions (1)
File Issue
version-management/troubleshooting.mdx line 99 Passive voice — Line uses passive voice ('is not supported by Version Management', 'is not supported') Fix: Rewrite in active voice, e.g. 'Version Management does not support Terraform. If you currently use Terraform... choose either Terraform or Version Management — Version Management does not support using both simultaneously.'

Redirects

No missing redirect entries found.

Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.

@ngayerie

Copy link
Copy Markdown
Collaborator Author

Hi @jhutchings1 , could you please approve this PR?

@jhutchings1 jhutchings1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@ngayerie ngayerie merged commit 49e7789 into production Jun 30, 2026
16 checks passed
@ngayerie ngayerie deleted the ngayerie/version-management-api-limitation branch June 30, 2026 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants