scylladb / scylla-manager

The Scylla Manager
https://manager.docs.scylladb.com/stable/
Other
52 stars 34 forks source link

docs: Issue in page Cluster #3301

Open AdamStawarz opened 1 year ago

AdamStawarz commented 1 year ago

I would like to report an issue in page https://manager.docs.scylladb.com/branch-3.0/sctool/cluster

Problem

Missing information about --id UUID argument in https://manager.docs.scylladb.com/stable/sctool/cluster.html

Suggest a fix

This information have to be copied from: https://manager.docs.scylladb.com/stable/add-a-cluster.html

Each cluster has a unique ID (UUID), you will see it printed to stdout in sctool cluster add output when the cluster is added. You will use this ID in all commands where the cluster ID is required. Alternatively you can use the name you assigned to the cluster instead of the ID. You can also set a custom UUID using --id <my-UUID> flag.

Michal-Leszczynski commented 1 year ago

Just to clarify, the problem is that:

-i, --id
Explicitly specify cluster ID, when not provided random UUID will be generated.

is to little descriptive and it would be better, if we changed it to:

-i, --id
Explicitly specify cluster ID, when not provided random UUID will be generated and printed to stdout.
You will use this ID in all commands where the cluster ID is required.
Alternatively you can use the name you assigned to the cluster instead of the ID.

I wouldn't say that I see this as a missing information, but if you think that would improve general quality of SM docs, then it can be added.

Michal-Leszczynski commented 1 year ago

right, @AdamStawarz ?

karol-kokoszka commented 1 year ago

@AdamStawarz ping