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

Reduce "scw apple-silicon server create" helper message ambiguity #4283

Open
stephane-klein opened this issue Nov 20, 2024 · 1 comment
Open
Assignees
Labels
apple-silicon Apple Silicon issues, bugs and feature requests core documentation enhancement ux

Comments

@stephane-klein
Copy link

Hi,

I read:

$ scw apple-silicon server create --help
Create a new server in the targeted zone, specifying its configuration including name and type.

USAGE:
  scw apple-silicon server create [arg=value ...]

ARGS:
  [name=<generated>]   Create a server with this given name
  [project-id]         Project ID to use. If none is passed the default project ID will be used
  [type]               Create a server of the given type
  [os-id]              Create a server with the given os_id
  [zone=fr-par-1]      Zone to target. If none is passed will use default zone from the config (fr-par-3)

...

I see [arg=value ...] and below I see:

  [project-id]         Project ID to use. If none is passed the default project ID will be used
  [type]               Create a server of the given type
  [os-id]              Create a server with the given os_id
  [zone=fr-par-1]      Zone to target. If none is passed will use default zone from the config (fr-par-3)

It's not easy to understand whether the correct syntax is :

$ scw apple-silicon server create name=myserver $SCW_PROJECT_ID  M1-M os-id=7a8d85fb-781a-4212-8e47-240ec0c3d23f fr-par-3

or

$ scw apple-silicon server create name=myserver project-id=$SCW_PROJECT_ID  type=M1-M os-id=7a8d85fb-781a-4212-8e47-240ec0c3d23f zone=fr-par-3

After a few attempts, I realized that the correct syntax is the second one.

Suggestion: update helper message like this:

  [project-id=46...]        Project ID to use. If none is passed the default project ID will be used
  [type=M1-M]               Create a server of the given type
  [os-id=7a8d...]            Create a server with the given os_id
  [zone=fr-par-1]          Zone to target. If none is passed will use default zone from the config (fr-par-3)

I think it reduces ambiguity. What do you think?

Best regards,
Stéphane

@stephane-klein
Copy link
Author

ping @remyleone

@remyleone remyleone added apple-silicon Apple Silicon issues, bugs and feature requests ux and removed bug labels Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apple-silicon Apple Silicon issues, bugs and feature requests core documentation enhancement ux
Projects
None yet
Development

No branches or pull requests

4 participants