scylladb / scylla-operator

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

Structurize, update and extend the documentation #2188

Open tnozicka opened 6 days ago

tnozicka commented 6 days ago

Description of your changes: This PR isn't fixing all the docs issues we have but it's an attempt to:

Which issue is resolved by this Pull Request: Resolves #1578 (and more)

Requires

tnozicka commented 3 days ago

/hold to test the flows before merging it (if we agree that this is how we do it in review)

rzetelskik commented 1 day ago

It fails building locally for me

/go/github.com/scylladb/scylla-operator/docs/source/resources/scylladbmonitorings.md:7: WARNING: Include file '/go/github.com/scylladb/scylla-operator/examples/monitoring/v1alpha1/scylladbmonitoring.yaml' not found or reading it failed [docutils]
...
sphinx-sitemap: sitemap.xml was generated for URL https://operator.docs.scylladb.com in /go/github.com/scylladb/scylla-operator/docs/_build/dirhtml/sitemap.xml
build finished with problems, 1 warning (with warnings treated as errors).
make: *** [Makefile:37: dirhtml] Error 1

command in README-dev.md should be updated with -v="$( pwd )/examples:/go/$( go list -m )/examples:Z"

preferably to:

 podman run -it --pull=Always --rm -v="$( pwd )/docs:/go/$( go list -m )/docs:Z" -v="$( pwd )/examples:/go/$( go list -m )/examples:Z"  --workdir="/go/$( go list -m )/docs" -p 5500:5500 quay.io/scylladb/scylla-operator-images:poetry-1.8 bash -euExo pipefail -O inherit_errexit -c 'poetry install && make --warn-undefined-variables dirhtml SPHINXOPTS="--keep-going" && make --warn-undefined-variables redirects && make preview'

to make it closer to what we do in CI

scylla-operator-bot[bot] commented 1 day ago

[APPROVALNOTIFIER] This PR is APPROVED

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

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](https://github.com/scylladb/scylla-operator/blob/master/OWNERS)~~ [tnozicka,zimnx] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
tnozicka commented 1 day ago

Forgot we have the readme - updated to mount the whole repo

rzetelskik commented 3 hours ago

/lgtm thanks for the updates

scylla-operator-bot[bot] commented 14 minutes ago

New changes are detected. LGTM label has been removed.

tnozicka commented 13 minutes ago

I am testing the quickstarts - pushed a few fixes as well as using a bit smaller machines so it gets through with default GKE quotas (that I've also hit).