-
Notifications
You must be signed in to change notification settings - Fork 153
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix: Modify help text for delete and purge domain #1894
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need to elaborate what deletion and purging are here, in addition to unifying the terminology.
This is what I agree with. |
Merge activity
|
Domain's purge help text explains delete. Of course, delete and purge are words used with similar meanings, but there is a command called domain delete, which can confuse users. ``` Delete the given virtual folder. Purge the given virtual folder. ``` I modified it by referring to the vfolder delete and purge help phrases above. **Checklist:** (if applicable) - [x] Milestone metadata specifying the target backport version - [ ] Mention to the original issue - [ ] Installer updates including: - Fixtures for db schema changes - New mandatory config options - [ ] Update of end-to-end CLI integration tests in `ai.backend.test` - [ ] API server-client counterparts (e.g., manager API -> client SDK) - [ ] Test case(s) to: - Demonstrate the difference of before/after - Demonstrate the flow of abstract/conceptual models with a concrete implementation - [ ] Documentation - Contents in the `docs` directory - docstrings in public interfaces and type annotations
Domain's purge help text explains delete. Of course, delete and purge are words used with similar meanings, but there is a command called domain delete, which can confuse users. ``` Delete the given virtual folder. Purge the given virtual folder. ``` I modified it by referring to the vfolder delete and purge help phrases above. **Checklist:** (if applicable) - [x] Milestone metadata specifying the target backport version - [ ] Mention to the original issue - [ ] Installer updates including: - Fixtures for db schema changes - New mandatory config options - [ ] Update of end-to-end CLI integration tests in `ai.backend.test` - [ ] API server-client counterparts (e.g., manager API -> client SDK) - [ ] Test case(s) to: - Demonstrate the difference of before/after - Demonstrate the flow of abstract/conceptual models with a concrete implementation - [ ] Documentation - Contents in the `docs` directory - docstrings in public interfaces and type annotations
Domain's purge help text explains delete.
Of course, delete and purge are words used with similar meanings, but there is a command called domain delete, which can confuse users.
I modified it by referring to the vfolder delete and purge help phrases above.
Checklist: (if applicable)
ai.backend.test
docs
directory