README.md: fix quickstart links #2293
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: mykaul The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
scylla-operator-bot
bot
added
do-not-merge/needs-kind
|
@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
force-pushed
the
README_fixes
branch
2 times, most recently
from
e2326d2 to
3afc882
Compare
scylla-operator-bot
bot
added
size/S
Fixes: scylladb#2270 In addition, renamed Scylla to ScyllaDB when needed. Signed-off-by: Yaniv Kaul <[email protected]>
| @@ -68,7 +72,7 @@ TODO: Link a dedicated roadmap. | |||
| ## Support | |||
| If you find a bug please file an [issue](https://github.com/scylladb/scylla-operator/issues) for us. | |||
|
|
|||
| We are also available on `#scylla-operator` channel on [Slack](https://scylladb-users-slackin.herokuapp.com/) if you have questions. | |||
| We are also available on `#scylla-operator` channel on [Slack](https://scylladb-users.slack.com) if you have questions. | |||
|
|
|||
| ## Contributing | |||
| We would **love** you to contribute to Scylla Operator, help make it even better and learn together! Have a look at the [Contributing Guide](docs/source/contributing.md) or reach out to us on `#scylla-operator` channel on [Slack](https://scylladb-users-slackin.herokuapp.com/) if you have questions. | |||
There was a problem hiding this comment.
Link to Slack channel in "Contributing" section is still invalid. Please update it from https://scylladb-users-slackin.herokuapp.com/ to https://scylladb-users.slack.com
@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). |
|
@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. 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. |
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. |
Fixes: #2270
Description of your changes:
Fixes README links to quickstarts
Which issue is resolved by this Pull Request:
Resolves 2270