-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Cloud Documentation Summer Cleaning 🧽 #81
Conversation
0e25287
to
636dabb
Compare
ca5ebb1
to
b232c4a
Compare
b232c4a
to
67da149
Compare
67da149
to
bec6f9b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Except one comment, documents looks good to me. Images render in the preview. I haven't spot obvious grammar or semantic errors.
I haven't review
- docs from perspective of grammar
- or from perspective links workings
- or if ::: blocks will render properly, though
Following actions are supported: | ||
* **Delete:** Deletes eligible partitions along with their data. | ||
* **Set replicas:** Changes the replication factor of eligible partitions. | ||
* **Force merge:** Merges segments on eligible partitions to ensure a specified number. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Example below, nicely explains "delete" and "set replication".
Do you think it would be possible to add in example below something that would use "Force merge"?
For me as a noob it's not clear what are benefits of doing this operation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I only moved this, will add an example in a next step
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Loving the automation page, and that you found the right name for it.
Manage Cluster <cluster/manage> | ||
Billing <organization/billing> | ||
API <organization/api> | ||
How Tos <howtos/index> | ||
Croud CLI <tutorials/deploy/croud> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Still no good way to discover https://cratedb.com/docs/cloud/cli/, because it became somehow orphaned, probably based on a slotting mistake of mine? Please let me know. I guess we may have a ticket about it already?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Those might be relevant in this context.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Still no good way to discover https://cratedb.com/docs/cloud/cli/, because it became somehow orphaned, probably based on a slotting mistake of mine? Please let me know. I guess we may have a ticket about it already?
Oh, I wasn't even aware that there are separate documentation pages. But then again, they're in a different repository. 🤦
Let's fix this in a next step.
bec6f9b
to
a28685c
Compare
What's Inside
I removed some outdated content that no longer aligns with the current state of things and flattened the menu hierarchy to make navigation easier. While there is a plan to continue refining this, I would appreciate early feedback to keep the review process straightforward. Most changes involve moving content around, so there's no need to delve into the details.
Preview
https://crate-cloud--81.org.readthedocs.build/en/81/
Highlights
Checklist