Skip to content

docs: update code block formatting and improve clarity in documentation#46

Merged
godsonten merged 2 commits into
mainfrom
issues/422-doc-fix
Jul 7, 2026
Merged

docs: update code block formatting and improve clarity in documentation#46
godsonten merged 2 commits into
mainfrom
issues/422-doc-fix

Conversation

@godsonten

@godsonten godsonten commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

What changed

Why


Summary by CodeRabbit

  • Documentation
    • Clarified and expanded multiple setup guides across compute, Kubernetes, networking, storage, and DNS.
    • Added clearer prerequisites and step-by-step flows for creating instances, clusters, load balancers, auto-scaling groups, and volumes.
    • Updated marketplace guides to consistently direct users to deploy a clean Ubuntu 24.04 LTS VM through the Marketplace or Instances flow.
    • Corrected several user-facing details, including SSH usernames, credit currency formatting, subnet address counts, and DNS timing wording.

@coderabbitai

coderabbitai Bot commented Jul 6, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@godsonten, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 11 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 301223ec-a0c9-4b02-bfc3-11e0e86111e5

📥 Commits

Reviewing files that changed from the base of the PR and between b1a9c22 and 6461311.

📒 Files selected for processing (1)
  • src/content/docs/public-cloud/kubernetes/create-cluster.md
📝 Walkthrough

Walkthrough

This PR updates documentation content across the public-cloud docs site, including reordered walkthrough steps (compute instance creation, load balancer, block storage, kubernetes), standardized Marketplace-based Ubuntu deployment instructions across ~25 marketplace pages, wording/punctuation fixes, and code-fence typing (text) for many snippet blocks.

Changes

Core instance/networking/getting-started docs

Layer / File(s) Summary
Auto-scaling prerequisites and steps
src/content/docs/public-cloud/auto-scaling/index.md
Adds a caution block on Load Balancer/rule prerequisites and expands the setup steps with plan, policy, and capacity planner details.
SSH connection guidance
src/content/docs/public-cloud/compute/connect-ssh.md
Updates default username wording, changes Oracle Linux default username to cloud-user, and reformats provisioning password guidance.
Compute instance creation flow
src/content/docs/public-cloud/compute/create-instance.md
Reorders and expands the creation walkthrough with new project/location/storage/network/public IP/affinity group sections and updated connection instructions.
DNS domains and records
src/content/docs/public-cloud/dns/domains.md, src/content/docs/public-cloud/dns/records.md
Rewords propagation timing and reformats record examples into typed code fences.
Getting-started pages
src/content/docs/public-cloud/getting-started/*
Removes duplicate headings, updates currency formatting, and adjusts CPU type wording.
Kubernetes cluster and dashboard docs
src/content/docs/public-cloud/kubernetes/*
Reformats content into bullets, reorders creation steps, removes the network step, and updates a code fence type.
Load balancer step ordering
src/content/docs/public-cloud/load-balancer/index.md
Swaps Project and Location step order.
Networking, VPN, and OS docs
src/content/docs/public-cloud/networking/vpc/*, src/content/docs/public-cloud/operating-systems/windows-11.md
Corrects usable IP count, rewords VPN intro, and pluralizes setup wizard wording.
Storage documentation
src/content/docs/public-cloud/storage/block-storage/*, src/content/docs/public-cloud/storage/object-storage/*
Reorders sections, rewords snapshot guidance, reformats CLI docs, and adjusts bucket bullet formatting.

Estimated code review effort: 2 (Simple) | ~15 minutes

Marketplace deployment instructions standardization

Layer / File(s) Summary
Standardized Ubuntu 24.04 marketplace deployment steps
src/content/docs/public-cloud/marketplace/apache-kafka.md, .../apache-tomcat.md, .../artifactory.md, .../authentik.md, .../clickhouse.md, .../forgejo.md, .../gitea.md, .../haproxy.md, .../harbor.md, .../jenkins.md, .../keycloak.md, .../mattermost.md, .../neo4j.md, .../nexus.md, .../nginx-proxy-manager.md, .../nginx.md, .../openbao.md, .../portainer.md, .../rabbitmq.md, .../rancher.md, .../seaweedfs.md, .../supabase.md, .../wg-easy.md, .../wikijs.md
Replaces app-specific deployment instructions with a common Apps → Marketplace search-and-deploy flow for Ubuntu 24.04 LTS across all listed pages.
Marketplace wording and code-fence fixes
.../beszel.md, .../elasticsearch.md, .../ghost.md, .../influxdb.md, .../mongodb.md, .../postgresql.md, .../valkey.md
Fixes punctuation, spelling, code-fence typing, and adds a MySQL security step.

Estimated code review effort: 2 (Simple) | ~15 minutes

Possibly related PRs

  • zsoftly/zcp-docs#5: Both PRs modify the compute instance creation doc, though targeting different sections.
  • zsoftly/zcp-docs#12: Overlaps on Marketplace documentation formatting/content, including Elasticsearch.
  • zsoftly/zcp-docs#26: Both modify the Auto-Scaling group creation documentation section.

Suggested reviewers: ditahm6, ClintonChe, ditahkk

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is still the template placeholder and provides no actual 'What changed' or 'Why' details. Fill in the 'What changed' and 'Why' sections with a brief summary of the documentation updates and the reason for them.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is related to the PR’s docs formatting and clarity updates, though it is broader than the actual mix of content changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch issues/422-doc-fix

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/content/docs/public-cloud/kubernetes/create-cluster.md`:
- Around line 46-56: The numbered setup flow in the create-cluster docs skips
the Network step, leaving the instructions incomplete. Update the sequence
around the cluster setup list in create-cluster.md to restore the Network item
in the correct position alongside Project, Location, Cluster Capacity, Advanced
Settings, Cluster Name, and Create, so it matches the form fields shown in the
screenshot caption.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a731e970-7533-4e5d-bad6-d5d204e73a0b

📥 Commits

Reviewing files that changed from the base of the PR and between 140fe17 and b1a9c22.

📒 Files selected for processing (49)
  • src/content/docs/public-cloud/auto-scaling/index.md
  • src/content/docs/public-cloud/compute/connect-ssh.md
  • src/content/docs/public-cloud/compute/create-instance.md
  • src/content/docs/public-cloud/dns/domains.md
  • src/content/docs/public-cloud/dns/records.md
  • src/content/docs/public-cloud/getting-started/account-signup.md
  • src/content/docs/public-cloud/getting-started/introduction.md
  • src/content/docs/public-cloud/getting-started/quickstart.md
  • src/content/docs/public-cloud/kubernetes/create-cluster.md
  • src/content/docs/public-cloud/kubernetes/dashboard-access.md
  • src/content/docs/public-cloud/load-balancer/index.md
  • src/content/docs/public-cloud/marketplace/apache-kafka.md
  • src/content/docs/public-cloud/marketplace/apache-tomcat.md
  • src/content/docs/public-cloud/marketplace/artifactory.md
  • src/content/docs/public-cloud/marketplace/authentik.md
  • src/content/docs/public-cloud/marketplace/beszel.md
  • src/content/docs/public-cloud/marketplace/clickhouse.md
  • src/content/docs/public-cloud/marketplace/elasticsearch.md
  • src/content/docs/public-cloud/marketplace/forgejo.md
  • src/content/docs/public-cloud/marketplace/ghost.md
  • src/content/docs/public-cloud/marketplace/gitea.md
  • src/content/docs/public-cloud/marketplace/haproxy.md
  • src/content/docs/public-cloud/marketplace/harbor.md
  • src/content/docs/public-cloud/marketplace/influxdb.md
  • src/content/docs/public-cloud/marketplace/jenkins.md
  • src/content/docs/public-cloud/marketplace/keycloak.md
  • src/content/docs/public-cloud/marketplace/mattermost.md
  • src/content/docs/public-cloud/marketplace/mongodb.md
  • src/content/docs/public-cloud/marketplace/neo4j.md
  • src/content/docs/public-cloud/marketplace/nexus.md
  • src/content/docs/public-cloud/marketplace/nginx-proxy-manager.md
  • src/content/docs/public-cloud/marketplace/nginx.md
  • src/content/docs/public-cloud/marketplace/openbao.md
  • src/content/docs/public-cloud/marketplace/portainer.md
  • src/content/docs/public-cloud/marketplace/postgresql.md
  • src/content/docs/public-cloud/marketplace/rabbitmq.md
  • src/content/docs/public-cloud/marketplace/rancher.md
  • src/content/docs/public-cloud/marketplace/seaweedfs.md
  • src/content/docs/public-cloud/marketplace/supabase.md
  • src/content/docs/public-cloud/marketplace/valkey.md
  • src/content/docs/public-cloud/marketplace/wg-easy.md
  • src/content/docs/public-cloud/marketplace/wikijs.md
  • src/content/docs/public-cloud/networking/vpc/create-vpc.md
  • src/content/docs/public-cloud/networking/vpc/vpn-users.md
  • src/content/docs/public-cloud/operating-systems/windows-11.md
  • src/content/docs/public-cloud/storage/block-storage/create-volume.md
  • src/content/docs/public-cloud/storage/block-storage/snapshots.md
  • src/content/docs/public-cloud/storage/object-storage/cli.md
  • src/content/docs/public-cloud/storage/object-storage/create-bucket.md
💤 Files with no reviewable changes (1)
  • src/content/docs/public-cloud/getting-started/introduction.md

Comment thread src/content/docs/public-cloud/kubernetes/create-cluster.md
@godsonten godsonten merged commit 79ff122 into main Jul 7, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants