Add explanation docs - #69
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #69 +/- ##
=======================================
Coverage 99.48% 99.48%
=======================================
Files 27 27
Lines 979 979
=======================================
Hits 974 974
Misses 5 5 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
| |**Step**|**Description** |**Run by**| | ||
| |--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| | ||
| |Compare |Compare the snapshot taken of the previous deployment with the modulefiles and built modules that already exist. This ensures that the Deployment Area is in a healthy state |`compare` | | ||
| |Validate|Process the updated configuration. By comparing the new configuration files with a snapshot from the previous deployment, we determine the set of actions that need to be taken |`validate`, `sync`| |
There was a problem hiding this comment.
Does validate not run compare in order to validate?
There was a problem hiding this comment.
No, compare ensures that the deployment area is healthy. Validate ensures that the new configuration (and lifecyle transitions compared to the current snapshot) are valid.
Validate just assumes that the current snapshot is accurate.
There was a problem hiding this comment.
ah okay i understand now
Should "with a snapshot" be "with the snapshot file"? We are referring to the deployment.yaml file right? Sometimes the language is a bit imprecise, I think it would be better to just mention this file directly rather than saying snapshot in some places.
There was a problem hiding this comment.
Used more specific language, and consistent terms between different sections
| - `compare --use-ref <ref>` compares the area against the snapshot stored at a previous | ||
| git commit of the deployment area (e.g. `HEAD~1`), since each `sync` commits the |
There was a problem hiding this comment.
I dont like ,since each sync commits the snapshot. but im not sure how to improve it. Maybe just remove it from here? It doesnt read very well
2 participants
There's a lot of words in the docs, so I've split them into two PRs.
The next PR will include an end-to-end tutorial plus CI pipeline configuration docs.