Skip to content
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

Merged
merged 1 commit into from
May 3, 2024

Conversation

Yaminyam
Copy link
Member

@Yaminyam Yaminyam commented Feb 6, 2024

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)

  • 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

@Yaminyam Yaminyam added this to the 23.03 milestone Feb 6, 2024
@github-actions github-actions bot added comp:client Related to Client component size:XS ~10 LoC labels Feb 6, 2024
Copy link
Member

@achimnol achimnol left a 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.

@achimnol achimnol added skip:changelog Make the action workflow to skip towncrier check area:ux UI / UX issue. labels Feb 19, 2024
@Yaminyam
Copy link
Member Author

I think we need to elaborate what deletion and purging are here, in addition to unifying the terminology.

This is what I agree with.
Since purge and delete are not often used together, I think it is necessary to inform users of this in detail.

@kyujin-cho kyujin-cho added the action:on hold Hold it. Wait for the restart. label Mar 29, 2024
@Yaminyam Yaminyam modified the milestones: 23.03, 23.09 Apr 24, 2024
@Yaminyam Yaminyam requested a review from achimnol April 24, 2024 06:33
@Yaminyam Yaminyam removed the action:on hold Hold it. Wait for the restart. label Apr 24, 2024
Copy link

graphite-app bot commented May 3, 2024

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
@github-actions github-actions bot added the comp:cli Related to CLI component label May 3, 2024
@graphite-app graphite-app bot merged commit e9c686c into main May 3, 2024
26 checks passed
@graphite-app graphite-app bot deleted the fix/domain-help branch May 3, 2024 13:32
jopemachine pushed a commit that referenced this pull request May 7, 2024
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:ux UI / UX issue. comp:cli Related to CLI component comp:client Related to Client component size:XS ~10 LoC skip:changelog Make the action workflow to skip towncrier check
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants