update docs for versioning agent config
Issue - Document versioning worksapces agent config (#481721 - closed)
What does this MR do and why?
After we have finished the versioning agent config feature development, we should document on this feature with internal engineer-facing doc. very minimal for customer-facing doc, as this is technical details that should not matter customers.
MR acceptance checklist
Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.
-
doc how versioning agent_config works with paper_trail, explain what happened for update/create (between agent_config table and agent_config_version table) -
doc how workspace linked with a given version -
Document how versioning works. E.g., what each of these versions means: 0
,1
,>1
-
Add developer-facing (https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/remote_development/README.md) -
Add user-facing docs.
Screenshots or screen recordings
Screenshots are required for UI changes, and strongly recommended for all other merge requests.
Before | After |
---|---|
How to set up and validate locally
Numbered steps to set up and validate the change are strongly suggested.
Edited by Zhaochen Li