Fix dead links and make minor cleanups in documentation

[mflendrich]

Resolves #2270

This PR continues the work in #2293. It:

• ensures that README.md points at the docs site, not at the markdown sources
• fixes the broken links as reported in Dead links in README.md for 1.15 release #2270 (comment)

Also:

• fixes some trivial typos
• renames release.md -> RELEASE.md for consistency with other [A-Z]+\.md files in the repo
• adds a human-readable README in the docs/ directory

/cc zimnx grzywin
/kind documentation
/priority important-longterm

[mflendrich]

/retest

…

On Mon, 24 Feb 2025 at 20:44, scylla-operator-bot[bot] < ***@***.***> wrote: @mflendrich <https://github.com/mflendrich>: 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-parallel-clusterip f100d42 <f100d42> link <https://prow.scylla-operator.scylladb.com/view/gs/scylla-operator-prow/pr-logs/pull/scylladb_scylla-operator/2499/pull-scylla-operator-master-e2e-gke-parallel-clusterip/1894076516061417472> true /test e2e-gke-parallel-clusterip Full PR test history <https://prow.scylla-operator.scylladb.com/pr-history?org=scylladb&repo=scylla-operator&pr=2499>. Your PR dashboard <https://prow.scylla-operator.scylladb.com/pr?query=is:pr+state:open+author:mflendrich> . Instructions for interacting with me using PR comments are available here <https://git.k8s.io/community/contributors/guide/pull-requests.md>. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow <https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:> repository. I understand the commands that are listed here <https://go.k8s.io/bot-commands>. — Reply to this email directly, view it on GitHub <#2499 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAUW4C3OLUG24JC7BGVV46T2RNZCXAVCNFSM6AAAAABXYSPYRSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNZZGQ4DEOBSHE> . You are receiving this because you were mentioned.Message ID: ***@***.***> [image: scylla-operator-bot[bot]]*scylla-operator-bot[bot]* left a comment (scylladb/scylla-operator#2499) <#2499 (comment)> @mflendrich <https://github.com/mflendrich>: 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-parallel-clusterip f100d42 <f100d42> link <https://prow.scylla-operator.scylladb.com/view/gs/scylla-operator-prow/pr-logs/pull/scylladb_scylla-operator/2499/pull-scylla-operator-master-e2e-gke-parallel-clusterip/1894076516061417472> true /test e2e-gke-parallel-clusterip Full PR test history <https://prow.scylla-operator.scylladb.com/pr-history?org=scylladb&repo=scylla-operator&pr=2499>. Your PR dashboard <https://prow.scylla-operator.scylladb.com/pr?query=is:pr+state:open+author:mflendrich> . Instructions for interacting with me using PR comments are available here <https://git.k8s.io/community/contributors/guide/pull-requests.md>. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow <https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:> repository. I understand the commands that are listed here <https://go.k8s.io/bot-commands>. — Reply to this email directly, view it on GitHub <#2499 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAUW4C3OLUG24JC7BGVV46T2RNZCXAVCNFSM6AAAAABXYSPYRSVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNZZGQ4DEOBSHE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[zimnx]

/lgtm

[scylla-operator-bot]

[APPROVALNOTIFIER] This PR is APPROVED

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

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [mflendrich,zimnx]

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