Env based management doc #2086
Merged
Env based management doc #2086
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces documentation for the Environment Based Management feature, detailing its purpose, functionality, and migration process. It explains the two types of environments (Virtual and Runtime), configuration snapshots, versioning, and the automatic/manual migration process for existing projects.
This commit improves the documentation for Environment Based Management by: - Clarifying the purpose and benefits of unifying Project Revisions and Project Environments. - Improving the descriptions of Virtual and Runtime Environments. - Detailing Configuration Snapshot functionality and versioning. - Providing a more structured explanation of the automatic and manual migration processes.
…ement documentation This commit refines the explanation of the migration process to Environment Based Management: - Improves clarity and user guidance for both automatic and manual migration methods. - Details prerequisites for automatic migration, including the requirement for at least one previous deployment and the inheritance of the most recent deployed revision configuration for runtime environments. - Explains the options available during manual migration, such as selecting configuration snapshots and choosing which revisions to convert to virtual environments. - Clarifies the behavior when users postpone migration.
This commit introduces documentation for the environment configuration promotion feature. The documentation explains that environment configuration promotion is a feature that allows users to easily propagate configuration changes across multiple environments, ensuring that all environments are using the same configuration, regardless of whether they are virtual or runtime environments.
…ement documentation This commit refines the explanation of the migration prompt within the Environment Based Management documentation. - Moves the explanation of the "Skip" button and closing the dialog to the initial introduction of the migration process, improving discoverability. - Removes the redundant explanation from the manual migration section.
This commit renames "Environment Based Management" to "Environment Based Configuration Management" and refines the documentation to improve clarity and detail. - Renames the feature to "Environment Based Configuration Management" for better accuracy. - Improves the introductory paragraph to emphasize the unified approach of integrating Project Revisions and Project Environments. - Adds a detailed explanation of the Environment Configuration Promotion feature, including its key capabilities: promoting configurations between environment types, selecting specific environment variables to transfer, reviewing and merging design configurations using an interactive diff editor, and maintaining granular control over settings.
…ement documentation This commit refines the explanation of environment types within the Environment Based Management documentation to improve clarity and detail. - Clarifies the roles of Virtual and Runtime Environments in providing a comprehensive project management solution. - Expands the description of Virtual Environments to emphasize their role in configuration management and experimentation. - Enhances the explanation of Runtime Environments, highlighting their function in connecting virtual environments to clusters for deployment and execution.
|
@mattia-fumo Manca un paragrafo in cui spiega tutte le differenze (oltre agli ambienti ed alla promote), quinidi:
|
This commit adds a quick reference section to the Environment Based Configuration Management documentation. The quick reference provides a summary of the key concepts of the feature, including the two environment categories, the ability to version and deploy only Runtime Environments, the default usage of the new approach for newly created Projects, and the use of Environment promotion to move configurations between environments.
… reference This commit adds a note about revisions being integrated into environments to the Environment Based Configuration Management quick reference.
…t documentation This commit refines the key concepts and overview section within the Environment Based Configuration Management documentation to improve clarity and detail. - Updates the quick reference section to a key concepts and overview section. - Expands on the key concepts, including dedicated environment configurations, environment categories, deployment capabilities, automatic utilization for new projects, configuration promotion, version control, environment variable display, and deployment restrictions.
…cumentation This commit adds an image illustrating the environments table to the Environment Based Configuration Management documentation. The image visually represents the different environment types and their relationships, enhancing the explanation of the feature.
This commit refines the key concepts and overview section within the Environment Based Configuration Management documentation to improve accuracy and clarity. - Clarifies that each environment "has" its own configuration. - Removes "for configuration management" from the Virtual Environments description for brevity. - Specifies that the enhanced environment-based management system is used by new projects using the Enhanced Workflow. - Changes "restricted to" to "bound to" for describing deployment configurations.
This commit clarifies that only Runtime Environments can be deployed using either the latest configuration or a specific versioned configuration in the Environment Based Configuration Management documentation. This change improves the accuracy and understanding of deployment options within the environment-based configuration system.
mattia-fumo
approved these changes
Apr 16, 2025
jacoposte
approved these changes
Apr 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Environment Based Management documentation
Pull Request Type
PR Checklist
Other information