Skip to content

Rewrite feature flag docs for rules, phases, and triggers - #3557

Draft
dylanlerch wants to merge 1 commit into
mainfrom
dylan/claude/feature-flag-rules-docs-e4ad74
Draft

dylanlerch wants to merge 1 commit into
mainfrom
dylan/claude/feature-flag-rules-docs-e4ad74

Conversation

@dylanlerch

@dylanlerch dylanlerch commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Context

Feature flags now use rules, phases, and triggers in place of the per-environment targeting form. Projects with existing flags stay on the legacy model until they're upgraded, so the old docs need to stay available.

Changes

  • New pages under feature-flags/: overview, getting started, how evaluation works, rules (including evaluation context), phased rollouts, rollout groups, previewing evaluations, managing flags, providers, and upgrading to rules
  • Existing pages moved to feature-flags/legacy/ with a banner pointing to the new docs
  • feature-flags/targeting and feature-toggles/targeting now redirect to feature-flags/legacy/targeting
  • Uses Octopus.FeatureFlags.ClientIdentifier (the old Octopus.FeatureToggles.ClientIdentifier is a deprecated alias)
  • Added rollouts and openfeature to the cspell dictionary

How to review

  • Pages follow contributing/standards (concept, guide, and reference page types). Unconfirmed facts are marked [VERIFY: …] or [PLACEHOLDER: …], and proposed screenshots are SUGGESTED VISUAL comments. All of these need resolving before this is ready.
  • Content is based on the OctopusDeploy source (rule and phase model, trigger resolver, legacy-to-rules converter, and environment editor UI). An SME check on accuracy is still needed.
  • The portal's UpgradeToFeatureFlagRules docs link should point to /docs/feature-flags/upgrading-to-rules.
  • I haven't built the site locally. Markdown lint, cspell, and a check of internal links and anchors pass.

Resolves BMBB-1256

Add new feature flag pages for rule-based flags (overview, getting
started, evaluation, rules and evaluation context, phased rollouts,
rollout groups, previews, managing flags, providers, and upgrading to
rules). Move the existing pages to feature-flags/legacy and redirect the
old targeting URLs there.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@team-marketing-branch-protections

Copy link
Copy Markdown

Pull request environment is available at https://stoctodocspr3557.z22.web.core.windows.net/.

You can view the ephemeral environment status in Octopus Deploy.

This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants