AWS quick documentation change
Summary
Restructured and simplified versioning documentation, condensed version type explanations into bullet points, removed detailed workflow descriptions, added version comparison table, removed 'Tips for success' section
Security assessment
The changes focus on simplifying documentation structure and clarifying versioning workflows. No security vulnerabilities, patches, or security-specific controls are mentioned. Versioning workflow changes relate to standard feature documentation without explicit security context.
Diff
diff --git a/quick/latest/userguide/versioning.md b/quick/latest/userguide/versioning.md index 44606a0c5..b142b0a44 100644 --- a//quick/latest/userguide/versioning.md +++ b//quick/latest/userguide/versioning.md @@ -5 +5 @@ -How versioning worksKey versioning conceptsCreating and editing flowsPublishing your flowMaking changes to shared flowsUnpublishing flowsTips for successVersion reference +How versioning worksPublishing changesUnpublishing flows @@ -9 +9 @@ How versioning worksKey versioning conceptsCreating and editing flowsPublishing -Versions help you manage your Amazon Quick Flows as you build, test, and share them with others. Think of versions like saving different copies of your work - you can have a working copy while keeping a clean, published version for others to use. Amazon Quick Flows keep it simple with no more than three versions for any given flow. +Amazon Quick Flows uses versioning to let you edit a flow without affecting the version that others are using. You can have up to three versions of a flow at any time. @@ -13 +13 @@ Versions help you manage your Amazon Quick Flows as you build, test, and share t -Your organization's setup determines which version types you'll see: +Your organization's setup determines which version types you see. @@ -17 +17 @@ Your organization's setup determines which version types you'll see: -You'll work with three types of versions. For detailed information about how approval reviews work, see the Amazon Quick Flows - Approval reviews documentation. +You work with three version types: @@ -19 +19 @@ You'll work with three types of versions. For detailed information about how app -🔧 Draft + * **Draft** — Your working copy. You can edit and test your flow without affecting the published version. As you edit, your flow is saved automatically. You can have one draft at a time. @@ -20,0 +21 @@ You'll work with three types of versions. For detailed information about how app + * **Pending Approval** — A version submitted for review. You can view it and check the approval status, but you cannot edit it. If changes are requested, update your draft and resubmit. @@ -22 +23 @@ You'll work with three types of versions. For detailed information about how app -**What it is:** your working copy where you build and test your flow. You can continue to run Drafts as private flows without ever sharing them. + * **Published** — The approved version that other users can access and run. @@ -24,43 +24,0 @@ You'll work with three types of versions. For detailed information about how app -**What you can do:** - - * Edit and modify your flow freely - - * Add cards like Amazon Quick Sight cards, file upload cards, and output cards - - * Test your changes before sharing - - * Save your work automatically as you go - - * Create multiple drafts to try different approaches - - - - -⏳ Pending Approval - - -**What it is:** this version of the flow is waiting for an eligible user to review and approve it for sharing. - -**What you can do:** - - * View your submitted flow (but can't edit it) - - * Check the approval status - - * Respond to reviewer feedback - - * Wait for approval or address requested changes before re-submitting it for review - - - - -✅ Published - - -**What it is:** Your approved flow that others can now use - -**What you can do:** - - * See your live, published flow - - * Use it as a starting point for new drafts @@ -69,0 +28 @@ You'll work with three types of versions. For detailed information about how app +For more information about approval reviews, see [Approval review](./approval-review.html). @@ -73,35 +32 @@ You'll work with three types of versions. For detailed information about how app -You'll work with two types of versions: - -🔧 Draft - - -**What it is:** Your private workspace for building flows - -**What you can do:** - - * Edit and test your flow - - * Save changes automatically - - * Keep your work private until ready to share - - - - -✅ Published - - -**What it is:** Your published flow that others can use immediately - -**What you can do:** - - * Publish directly when your flow is ready - - * Make it available to users right away - - * Use it as a baseline for future changes - - - - -## Key versioning concepts +You work with two version types: @@ -109 +34 @@ You'll work with two types of versions: -Understanding these core concepts will help you work effectively with Amazon Quick Flows versioning: + * **Draft** — Your working copy. You can edit and test your flow without affecting the published version. As you edit, your flow is saved automatically. You can have one draft at a time. @@ -111 +36 @@ Understanding these core concepts will help you work effectively with Amazon Qui -**Multi-versioning for creators:** As a flow creator, you can see and work with multiple versions of your flow (draft, pending approval, shared). This allows you to continue developing while users access the stable published version. + * **Published** — The version that other users can access and run. You can publish directly when your flow is ready. @@ -113 +37,0 @@ Understanding these core concepts will help you work effectively with Amazon Qui -**Single version for users:** End users always see only one version of your flow - the currently published version. This prevents confusion and ensures everyone has the same experience. @@ -115 +38,0 @@ Understanding these core concepts will help you work effectively with Amazon Qui -**Publish changes workflow:** When you make changes to an existing shared flow, you must "publish changes" to make those updates available to users. This creates a new version and may trigger approval review. @@ -117 +39,0 @@ Understanding these core concepts will help you work effectively with Amazon Qui -**Version replacement:** Each time you publish changes, the new version replaces the previous published version for all users. Historical versions are maintained for creators but users always see the latest approved version. @@ -119 +41,5 @@ Understanding these core concepts will help you work effectively with Amazon Qui -**App definition versioning:** Changes to core flow elements like title, description, and structure are considered app definition changes and require going through the full publishing process. +Version Type | Can Edit? | Visible to Users? | Next Step +---|---|---|--- +Draft | Yes | No | Publish (or submit for approval) +Pending Approval* | No | No | Wait for approval +Published | No | Yes | Create new draft for changes @@ -121 +47 @@ Understanding these core concepts will help you work effectively with Amazon Qui -## Creating and editing flows +*Pending Approval only applies if your organization uses approval review. @@ -123 +49 @@ Understanding these core concepts will help you work effectively with Amazon Qui -All new flows begin as drafts in your private workspace. You can build and test your flow, adding cards, configuring settings, and iterating as needed. Your work saves automatically, but you can manually save important milestones. When you're ready to share your flow with others, you'll need to "publish changes" to make it available to your intended audience. +## Publishing changes @@ -125 +51 @@ All new flows begin as drafts in your private workspace. You can build and test -## Publishing your flow +Any changes to a flow's title, description, steps, logic, or sharing permissions require publishing. When you publish, the new version replaces the current published version for all users. End users always see only the latest published version. @@ -127,17 +53 @@ All new flows begin as drafts in your private workspace. You can build and test -**With approval review:** When your draft is ready, you "publish changes" to submit it for review. Your flow moves to "Pending Approval" status where reviewers can evaluate it. If changes are requested, you'll need to create a new draft with updates and resubmit. Once approved, your flow becomes "Published" and available to users. Any future changes to a shared flow require republishing and going through the approval process again. - -**Without approval review:** When your draft is ready, you "publish changes" to share it immediately. Your flow becomes "Published" and available to users right away. You can continue making changes in draft mode and publish updates as needed. - -## Making changes to shared flows - -Once you've shared a flow, any changes you make require going through the "publish changes" process to make them available to users. This ensures that users always have access to a stable, tested version while you continue developing improvements. - -### The publish changes workflow - -When you modify a shared flow, you're working in a new draft version. Users continue to see and use the current published version until you complete the publish changes process. This approach prevents users from seeing incomplete or untested changes. - -**Title and description changes:** Updates to your flow's title or description are considered app definition changes. These require publishing changes and, if approval review is enabled, going through the approval process again. - -**Content changes:** Modifications to cards, prompts, or flow logic also require publishing changes. Each published update creates a new version that replaces the previous version for all users. - -**Sharing permission changes:** Adding new users or changing permissions (such as converting viewers to co-owners) may require approval depending on your organization's settings. +If your organization uses approval review, publishing submits your flow for review. Once approved, it becomes the new published version. Without approval review, publishing makes changes available immediately. @@ -147,67 +57 @@ When you modify a shared flow, you're working in a new draft version. Users cont -You can unpublish a shared flow to remove it from general availability while keeping it accessible to co-owners. When you unpublish a flow: - - * **Viewers lose access:** Users with viewer permissions can no longer see or use the flow - - * **Co-owners retain access:** Co-owners can still access and work with the unpublished flow - - * **Draft state:** The flow returns to draft state for further development - - * **No approval required:** Unpublishing does not require going through approval review - - - - -This feature is useful when you need to make significant changes to a widely-shared flow or temporarily remove access while addressing issues. - -## Tips for success - -Follow these best practices to ensure your flows work reliably and provide a great experience for your users. - -### Before you submit or publish - - * ✅ Test your flow thoroughly with different scenarios and inputs - - * ✅ Check that all steps work as expected - - * ✅ Verify data permissions are set up correctly for your intended users - - * ✅ Add clear descriptions and help text for users - - * ✅ Review any error handling or edge cases - - - - -### Managing multiple versions - - * Keep track of what changes you made in each version - - * Use descriptive names or notes to identify different versions - - * Don't delete important drafts until you're sure you won't need them - - - -