Fix quickstart links

[mykaul]

Fixes: #2270

Description of your changes:
Fixes README links to quickstarts

Which issue is resolved by this Pull Request:
Resolves 2270

[mykaul]

@grzywin - I'm unsure if it fixes the problem, but I hope the links are correct now. Perhaps we need fully hyperlink to the documentation in docs.scylladb.com? @annastuchlik ?

[grzywin]

@grzywin - I'm unsure if it fixes the problem, but I hope the links are correct now. Perhaps we need fully hyperlink to the documentation in docs.scylladb.com? @annastuchlik ?

@mykaul It looks good now. I checked your PR and links are working - except "Contributing Guide" which you are aware of and also one Slack channel link needs to be updated (I wrote about it in the code review).

[grzywin]

@mykaul @annastuchlik IMHO, it could also be beneficial for the clients to include a link to the basic-setup URL in the README.md file. It provides a great explanation of how the basic configuration of the Operator and Scylla should look.
https://github.com/scylladb/scylla-operator/blob/master/recordings/basic-setup/run.sh

The only thing that could be tweaked there is information about requirements regarding initial K8s configuration and some extra comment about NodeConfig configuration as the example in run.sh is doing it in GKE and we have also examples for EKS and Generic.

[rzetelskik]

IMHO, it could also be beneficial for the clients to include a link to the basic-setup URL in the README.md file. It provides a great explanation of how the basic configuration of the Operator and Scylla should look.
https://github.com/scylladb/scylla-operator/blob/master/recordings/basic-setup/run.sh

It defeats the entire effort of the docs explaining the architecture and different configuration options. With the recording people are just going to run the script. As you correctly pointed out it's also platform specific.

[mykaul]

@mykaul @annastuchlik IMHO, it could also be beneficial for the clients to include a link to the basic-setup URL in the README.md file. It provides a great explanation of how the basic configuration of the Operator and Scylla should look. https://github.com/scylladb/scylla-operator/blob/master/recordings/basic-setup/run.sh

The only thing that could be tweaked there is information about requirements regarding initial K8s configuration and some extra comment about NodeConfig configuration as the example in run.sh is doing it in GKE and we have also examples for EKS and Generic.

But this is unrelated to this PR?

[grzywin]

But this is unrelated to this PR?

Yes, this is unrelated (it is about basic-setup script), I just thought it is worth to mention about this here.

It defeats the entire effort of the docs explaining the architecture and different configuration options. With the recording people are just going to run the script. As you correctly pointed out it's also platform specific.

Well, you are right – the Operator is intended for more experienced users who understand the architecture, so the documentation should be the main source of information. However, if someone wants to experiment a bit, this shortcut to the basic setup could make things easier for them. Anyway, it was just a loose thought – you guys know the audience better than I do.

[rzetelskik]

Perhaps we need fully hyperlink to the documentation in docs.scylladb.com?

IMO yes, it's a better experience than just opening the markdown file in github.

@mykaul can you also please update the PR title and commit subject line to use the imperative mood? https://cbea.ms/git-commit/#imperative (it should be mentioned in the contribution guide which we currently don't have)

[mykaul]

@mykaul can you also please update the PR title and commit subject line to use the imperative mood? https://cbea.ms/git-commit/#imperative (it should be mentioned in the contribution guide which we currently don't have)

Once we have the guidelines, I'll improve it. See scylladb/scylladb#22214 for a very similar situation (scylladb/scylladb#22139 (comment) )

And btw, 'fix' is imperative.

[rzetelskik]

Once we have the guidelines, I'll improve it. See scylladb/scylladb#22214 for a very similar situation (scylladb/scylladb#22139 (comment) )

cc @zimnx, we should pick up #2130

And btw, 'fix' is imperative.

You're right, I should've said it shouldn't have the prefix. We should include that in the guide as well.

[mykaul]

You're right, I should've said it shouldn't have the prefix. We should include that in the guide as well.

SCT requires some prefix, Scylla requires a module, here I don't need a prefix at all... Oh boy.

[annastuchlik]

@grzywin - I'm unsure if it fixes the problem, but I hope the links are correct now. Perhaps we need fully hyperlink to the documentation in docs.scylladb.com? @annastuchlik ?

The links are correct, but it would be better to add links to the published documentation:

GKE quickstart: https://operator.docs.scylladb.com/stable/quickstarts/gke.html
EKS quickstart: https://operator.docs.scylladb.com/stable/quickstarts/eks.html

Installation generic: https://operator.docs.scylladb.com/stable/installation/kubernetes/generic.html
Installation GKE: https://operator.docs.scylladb.com/stable/installation/kubernetes/gke.html
Installation EKS: https://operator.docs.scylladb.com/stable/installation/kubernetes/eks.html

Releases: https://operator.docs.scylladb.com/stable/support/releases.html

[mflendrich]

/lgtm
/kind cleanup

[scylla-operator-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mflendrich, mykaul

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [mflendrich]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[mflendrich]

/override e2e-gke-multi-datacenter-parallel

[scylla-operator-bot]

@mflendrich: mflendrich unauthorized: /override is restricted to Repo administrators.

In response to this:

/override e2e-gke-multi-datacenter-parallel

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[mflendrich]

/test e2e-gke-multi-datacenter-parallel

[mflendrich]

/hold

to sort out the changelog autogeneration before merge

[mflendrich]

/test e2e-gke-multi-datacenter-parallel

[scylla-operator-bot]

@mykaul: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/e2e-gke-multi-datacenter-parallel	c4a0e97	link	true	/test e2e-gke-multi-datacenter-parallel

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[mflendrich]

/hold cancel
/lgtm