scylladb / scylla-operator

The Kubernetes Operator for ScyllaDB
https://operator.docs.scylladb.com/
Apache License 2.0
332 stars 163 forks source link

Minor improvements in documentation #2080

Open grzywin opened 1 month ago

grzywin commented 1 month ago

What should the feature do?

As someone relatively new to Kubernetes and Operator, I was attempting to configure a cluster using the instructions provided in the official Operator documentation. During this process, I encountered some minor issues and inconsistencies.

https://operator.docs.scylladb.com/stable/generic.html

https://operator.docs.scylladb.com/stable/monitoring.html

Most of these points are trivial, and if there are plans to rewrite the documentation, they can probably be discarded. However, I believe it’s important to acknowledge what might challenge newcomers.

What is the use case behind this feature?

Improve user experience.

Anything else we need to know?

No response

scylla-operator-bot[bot] commented 2 days ago

The Scylla Operator project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

You can:

/lifecycle stale