Documentation Triggers

Back to overview: Content Standards

Use this table to identify which documentation is required or optional for a given product change. Check the Lifecycle Modifier section first — the feature’s lifecycle stage (EA, Preview, GA) overrides some requirements.

Lifecycle Modifier

Feature lifecycle stages (EA, Preview, GA) are defined in the Aviatrix Feature Modes reference — that page is the authoritative source for stage definitions, support levels, and stability expectations. The required documentation depth changes based on the feature’s lifecycle stage. EA features may change significantly before reaching GA, so full documentation is premature at that stage.

Stage	Required	Optional	Notes
EA	Release Notice (EA status); Feature Modes table entry	Basic Config Guide	No Component doc yet — design may change significantly.
Preview	Release Notice; UI Reference for any new pages; Config Guide	Component doc (if architecturally significant)	Component doc is appropriate when the capability has a clear design model that architects need to understand.
GA	Full suite — see per-event table below	Validated Design	All referenced doc types should exist before a GA release ships.

Documentation Requirements by Event

Feature Events

Event	Required	Optional	Notes
New feature — EA	Release Notice; Feature Modes table entry	Basic Config Guide	Skip Component doc. Scope may change before Preview.
New feature — Preview	Release Notice; Config Guide; UI Reference (if new CoPilot page)	Component doc	Add Component doc when the feature has a distinct design model.
New feature — GA	Component doc (if architecturally significant); Config Guide; UI Reference (if new CoPilot page); Release Notice	Architecture; Validated Design	Architecture and Validated Design are appropriate when the feature introduces a new design pattern or has a reference implementation.
Feature promoted EA → Preview	Update Release Notice; update Feature Modes table	Expand Config Guide; add Component doc	Re-evaluate whether a Component doc is now warranted.
Feature promoted Preview → GA	Verify all GA-required docs exist; update Release Notice; update Feature Modes table	Validated Design	Block the GA release if required docs are missing.
Feature updated (new capabilities)	Update Component doc; update affected Config Guides; update UI Reference if fields changed	New Config Guide for new workflow	Update scope only — do not rewrite docs that remain accurate.
Feature deprecated	Add deprecation notice to Component doc and affected Config Guides; Release Notice	Migration guide (Operational Guide)	Note the deprecation version and the recommended replacement.
Feature removed	Remove or archive docs; Release Notice	—	Remove links from related docs. Update navigation JSON.

UI Events

Event	Required	Optional	Notes
New CoPilot page or panel	UI Reference doc	—	Required regardless of feature lifecycle stage.
Existing page gains fields or controls	Update UI Reference	—	Document every new visible field, even if the description is brief.
Existing page restructured or renamed	Update UI Reference; update navigation links	—	Check all Config Guides that reference the old navigation path.

Solution and Architecture Events

Event	Required	Optional	Notes
New solution identified	Solution doc	Architecture; Validated Design; Config Guides	Architecture and Validated Design are optional but recommended when a reusable pattern or reference implementation exists. Config Guides are required when the solution involves multi-step configuration not already covered.
New validated implementation exists	Validated Design	—	Requires a real implemented outcome — not hypothetical. See Validated Design.
New generic design pattern identified	Architecture doc	—	Only when the pattern is reusable across multiple solutions and not tied to one specific implementation.

Integration and Platform Events

Event	Required	Optional	Notes
New cloud provider support for existing feature	Update Component doc (add cloud to supported scope); add cloud-specific tab to Config Guides	—	Check all affected Config Guides, not just the primary one.
New third-party integration	Solution doc; Config Guide	—	The Solution doc makes the case; the Config Guide covers the steps.
New Terraform resource or data source	Terraform Reference	Update Config Guide with Terraform tab	Add the Terraform tab to the relevant Config Guide if Terraform is a realistic deployment path.
API endpoint added or changed	API Reference	Release Notice (if breaking or behavior-changing)	Breaking API changes always require a Release Notice.

Maintenance Events

Event	Required	Optional	Notes
Bug fix that changes documented behavior	Update affected Config Guides and UI Reference	Release Notice	Release Notice is appropriate when the fix is user-visible or corrects behavior users may have worked around.
Known limitation resolved	Remove or update Limitations section in Component doc	Release Notice
Performance or scale improvement	Update Component doc Best Practices if guidance changes	Validated Design (if a new reference implementation reflects the improvement)
Major operational or compatibility issue found in production	Field Notice	Update affected Operational Guides	Field Notices are proactive customer notifications with severity, impact scope, and required actions. Not a Release Notice.
Security vulnerability or CVE	PSIRT advisory	Update affected Operational Guides	Handled by the PSIRT process — not a Field Notice or Release Notice.

Which Doc Type Should I Use?
Aviatrix Feature Modes — authoritative source for EA, Preview, and GA stage definitions

Concepts & Architecture

Guides

Reference

Documentation triggers

Documentation Triggers

Lifecycle Modifier

Documentation Requirements by Event

Feature Events

UI Events

Solution and Architecture Events

Integration and Platform Events

Maintenance Events

​Documentation Triggers

​Lifecycle Modifier

​Documentation Requirements by Event

​Feature Events

​UI Events

​Solution and Architecture Events

​Integration and Platform Events

​Maintenance Events

​Related

Documentation Triggers

Lifecycle Modifier

Documentation Requirements by Event

Feature Events

UI Events

Solution and Architecture Events

Integration and Platform Events

Maintenance Events

Related