Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Andrew Bates <[email protected]>
  • Loading branch information
chadell and abates authored May 28, 2024
1 parent 7b2c753 commit c47f7e3
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/user/design_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion docs/user/design_testing.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit c47f7e3

Please sign in to comment.