From c47f7e3e9a272d37e3bc1fb5fcb8eb71a45650b6 Mon Sep 17 00:00:00 2001 From: Christian Adell Date: Tue, 28 May 2024 18:17:56 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Andrew Bates --- docs/user/design_development.md | 2 +- docs/user/design_testing.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user/design_development.md b/docs/user/design_development.md index 9d23e0c..4be46e2 100644 --- a/docs/user/design_development.md +++ b/docs/user/design_development.md @@ -108,7 +108,7 @@ Design files specifies a list of Jinja template that should be used to produce t ### `design_mode` -The `design_mode` indicates how this design's state will be tracked in Nautobot. By default, the design mode is set to CLASSIC` mode, which means that objects are created in an ad-hoc fashion and no change sets are created. Classic mode is how all designs worked prior to the introduction of the design lifecycle features. If a design is intended to be tracked as a deployment, then design mode should be set to `DEPLOYMENT` in order to implement the full lifecycle. +The `design_mode` indicates how this design's state will be tracked in Nautobot. By default, the design mode is set to `CLASSIC` mode, which means that objects are created in an ad-hoc fashion and no change sets are created. Classic mode is how all designs worked prior to the introduction of the design lifecycle features. If a design is intended to be tracked as a deployment, then design mode should be set to `DEPLOYMENT` in order to implement the full lifecycle. ### `context_class` diff --git a/docs/user/design_testing.md b/docs/user/design_testing.md index 5f8569b..e0c73ac 100644 --- a/docs/user/design_testing.md +++ b/docs/user/design_testing.md @@ -1,6 +1,6 @@ # Design Testing -Design Builder bring the higher responsibility for intended data generation to the design. The user's input data will tailor each deployment, but everything is done within the guardrails of the design. Thus, the designs **should** be tested properly on a continuous integration to ensure that they are behaving as expected. +Design Builder brings the higher responsibility for intended data generation to the design. The user's input data will tailor each deployment, but everything is done within the guardrails of the design. Thus, the designs **should** be tested properly on a continuous integration to ensure that they are behaving as expected. This means that if the design is only for ad-hoc deployments (i.e., not tracked), at least the expected output should be validated for a few input data sets. If the design is implementing the lifecycle, then the tests should include the update and decommissioning features to grant that it will behave as expected.