Update documentation for ZCP CLI and operating systems#25
Merged
Conversation
- Updated CLI reference to reflect version change from v0.0.9 to v0.0.19 and added IAM commands. - Enhanced Console Access documentation with detailed steps for accessing and using the console. - Added CLI management instructions for IAM roles and sub-users. - Introduced new operating system documentation for AlmaLinux, Oracle Linux, Rocky Linux, and Ubuntu, including deployment steps and default login information. - Added Windows 11 Pro and Windows Server documentation, detailing licensing, activation, and first sign-in procedures.
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds OS image docs and routing, expands IAM CLI and changelog docs in English and French, rewrites console access guidance, adds Drupal marketplace docs and listings, and replaces many French placeholder screenshots with real images. ChangesOperating system images
IAM CLI, changelog, and console access
Marketplace Drupal
French screenshot documentation updates
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/content/docs/public-cloud/compute/console-access.md (1)
46-59:⚠️ Potential issue | 🟠 MajorRemove Clipboard and Full-Screen Mode from the keyboard-shortcuts list.
Lines 37-44 correctly identify Clipboard (marked 2) and Full-Screen Mode (marked 3) as separate toolbar buttons. However, lines 57-58 incorrectly list them under the Extra keys menu. The noVNC Extra keys menu provides only keyboard-input simulators (Control, Alt, Shift, Windows, Tab, Escape, Ctrl+Alt+Delete), not toolbar features like Clipboard or Full-Screen Mode. These should be removed from the keyboard-shortcuts section.
🤖 Prompt for 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. In `@src/content/docs/public-cloud/compute/console-access.md` around lines 46 - 59, The keyboard shortcuts section incorrectly lists Clipboard and Full-Screen Mode as part of the Extra keys menu, but these are actually separate toolbar buttons (correctly identified earlier in the document). Remove the last two bullet points from the keyboard shortcuts list: the bullet point describing Clipboard as "Copies text between the local machine and the VM" and the bullet point describing Full-Screen Mode as "Expands the VM console to full-screen". Keep only the actual keyboard input simulators (Toggle Control, Toggle Alt, Toggle Shift, Toggle Windows Key, Send Tab, Send Escape, and Send Ctrl+Alt+Delete) in the Extra keys menu description.
🧹 Nitpick comments (1)
src/content/docs/public-cloud/compute/console-access.md (1)
1-72: Run the content-review-agent before finalizing this PR.Per the project's required development workflow (documented in retrieved learnings), you must run the
content-review-agenttool on this changed file and apply all of its fixes before handing back. After applying any fixes, validate with:pnpm fmt pnpm fmt:check pnpm lint pnpm typecheck pnpm build pnpm dev pnpm previewDo not commit after validation — the maintainer will handle that.
Do you want me to verify the image asset paths and generate a shell script to check for link validity across the changed section?
🤖 Prompt for 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. In `@src/content/docs/public-cloud/compute/console-access.md` around lines 1 - 72, Run the content-review-agent tool on the file src/content/docs/public-cloud/compute/console-access.md and apply all suggested fixes. After applying the fixes, validate the changes by executing the following commands in sequence: pnpm fmt, pnpm fmt:check, pnpm lint, pnpm typecheck, pnpm build, pnpm dev, and pnpm preview. Do not commit the changes after validation as the maintainer will handle the final commit.Source: Learnings
🤖 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.
Outside diff comments:
In `@src/content/docs/public-cloud/compute/console-access.md`:
- Around line 46-59: The keyboard shortcuts section incorrectly lists Clipboard
and Full-Screen Mode as part of the Extra keys menu, but these are actually
separate toolbar buttons (correctly identified earlier in the document). Remove
the last two bullet points from the keyboard shortcuts list: the bullet point
describing Clipboard as "Copies text between the local machine and the VM" and
the bullet point describing Full-Screen Mode as "Expands the VM console to
full-screen". Keep only the actual keyboard input simulators (Toggle Control,
Toggle Alt, Toggle Shift, Toggle Windows Key, Send Tab, Send Escape, and Send
Ctrl+Alt+Delete) in the Extra keys menu description.
---
Nitpick comments:
In `@src/content/docs/public-cloud/compute/console-access.md`:
- Around line 1-72: Run the content-review-agent tool on the file
src/content/docs/public-cloud/compute/console-access.md and apply all suggested
fixes. After applying the fixes, validate the changes by executing the following
commands in sequence: pnpm fmt, pnpm fmt:check, pnpm lint, pnpm typecheck, pnpm
build, pnpm dev, and pnpm preview. Do not commit the changes after validation as
the maintainer will handle the final commit.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 5ec3acdb-ffd8-4daf-a60e-784d302aa6dc
📒 Files selected for processing (20)
CLAUDE.mdastro.config.mjssrc/assets/compute/console-vm-overview.webpsrc/assets/compute/console-vnc-session.webpsrc/content/docs/changelog/index.mdsrc/content/docs/fr/changelog/index.mdsrc/content/docs/fr/public-cloud/cli/reference.mdsrc/content/docs/fr/public-cloud/iam/roles.mdsrc/content/docs/fr/public-cloud/iam/users.mdsrc/content/docs/public-cloud/cli/reference.mdsrc/content/docs/public-cloud/compute/console-access.mdsrc/content/docs/public-cloud/iam/roles.mdsrc/content/docs/public-cloud/iam/users.mdsrc/content/docs/public-cloud/operating-systems/alma-linux.mdsrc/content/docs/public-cloud/operating-systems/index.mdsrc/content/docs/public-cloud/operating-systems/oracle-linux.mdsrc/content/docs/public-cloud/operating-systems/rocky-linux.mdsrc/content/docs/public-cloud/operating-systems/ubuntu.mdsrc/content/docs/public-cloud/operating-systems/windows-11.mdsrc/content/docs/public-cloud/operating-systems/windows-server.md
…tion and CLI deletion
There was a problem hiding this comment.
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/fr/public-cloud/iam/users.md`:
- Around line 21-34: Before merging this pull request, you must run the
content-review-agent tool on the modified documentation file to validate it
against coding guidelines. Execute the content-review-agent validation on the
file, review any violations or issues it reports, apply the suggested fixes to
address those violations, and then re-run the validation to confirm that zero
violations remain. This is a mandatory requirement and blocking issue that must
be completed and verified before the changes can be merged.
🪄 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: 08f19be4-c741-4442-b2bb-c76050f48e31
📒 Files selected for processing (4)
src/content/docs/fr/public-cloud/iam/users.mdsrc/content/docs/public-cloud/iam/users.mdsrc/content/docs/public-cloud/operating-systems/index.mdsrc/content/docs/public-cloud/operating-systems/windows-server.md
✅ Files skipped from review due to trivial changes (3)
- src/content/docs/public-cloud/operating-systems/index.md
- src/content/docs/public-cloud/iam/users.md
- src/content/docs/public-cloud/operating-systems/windows-server.md
There was a problem hiding this comment.
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/fr/public-cloud/kubernetes/cluster-overview.md`:
- Line 24: The French terminology in the documentation uses the incorrect
spelling without the œ ligature; update the text in the affected markdown to use
“Nœuds” and “nœuds” instead of “Noeuds” and “noeuds”, keeping the rest of the
phrase unchanged.
🪄 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: f20c9132-9c40-4140-bcd3-2a158d538fc9
📒 Files selected for processing (28)
src/content/docs/fr/public-cloud/affinity-groups/index.mdsrc/content/docs/fr/public-cloud/auto-scaling/index.mdsrc/content/docs/fr/public-cloud/backups-snapshots/backups.mdsrc/content/docs/fr/public-cloud/backups-snapshots/vm-snapshots.mdsrc/content/docs/fr/public-cloud/compute/connect-rdp.mdsrc/content/docs/fr/public-cloud/compute/connect-ssh.mdsrc/content/docs/fr/public-cloud/compute/create-instance.mdsrc/content/docs/fr/public-cloud/compute/instance-overview.mdsrc/content/docs/fr/public-cloud/compute/power-management.mdsrc/content/docs/fr/public-cloud/compute/settings/block-storage.mdsrc/content/docs/fr/public-cloud/compute/settings/change-os.mdsrc/content/docs/fr/public-cloud/compute/settings/firewall.mdsrc/content/docs/fr/public-cloud/compute/settings/networks.mdsrc/content/docs/fr/public-cloud/compute/settings/port-forwarding.mdsrc/content/docs/fr/public-cloud/compute/settings/ssh-keys.mdsrc/content/docs/fr/public-cloud/kubernetes/cluster-overview.mdsrc/content/docs/fr/public-cloud/kubernetes/create-cluster.mdsrc/content/docs/fr/public-cloud/load-balancer/index.mdsrc/content/docs/fr/public-cloud/networking/public-network/create.mdsrc/content/docs/fr/public-cloud/networking/public-network/overview.mdsrc/content/docs/fr/public-cloud/networking/public-network/public-ips.mdsrc/content/docs/fr/public-cloud/networking/vpc/network-acls.mdsrc/content/docs/fr/public-cloud/networking/vpc/site-vpn.mdsrc/content/docs/fr/public-cloud/storage/block-storage/create-volume.mdsrc/content/docs/fr/public-cloud/storage/block-storage/snapshots.mdsrc/content/docs/fr/public-cloud/storage/object-storage/create-bucket.mdsrc/content/docs/public-cloud/compute/create-instance.mdsrc/content/docs/public-cloud/compute/settings/change-os.md
✅ Files skipped from review due to trivial changes (22)
- src/content/docs/fr/public-cloud/compute/settings/firewall.md
- src/content/docs/fr/public-cloud/networking/public-network/public-ips.md
- src/content/docs/fr/public-cloud/networking/vpc/site-vpn.md
- src/content/docs/fr/public-cloud/backups-snapshots/vm-snapshots.md
- src/content/docs/fr/public-cloud/compute/settings/block-storage.md
- src/content/docs/fr/public-cloud/backups-snapshots/backups.md
- src/content/docs/fr/public-cloud/compute/power-management.md
- src/content/docs/fr/public-cloud/load-balancer/index.md
- src/content/docs/fr/public-cloud/auto-scaling/index.md
- src/content/docs/fr/public-cloud/networking/public-network/overview.md
- src/content/docs/fr/public-cloud/storage/block-storage/snapshots.md
- src/content/docs/fr/public-cloud/affinity-groups/index.md
- src/content/docs/fr/public-cloud/kubernetes/create-cluster.md
- src/content/docs/fr/public-cloud/compute/settings/change-os.md
- src/content/docs/fr/public-cloud/compute/connect-ssh.md
- src/content/docs/fr/public-cloud/compute/settings/networks.md
- src/content/docs/fr/public-cloud/storage/object-storage/create-bucket.md
- src/content/docs/fr/public-cloud/compute/connect-rdp.md
- src/content/docs/fr/public-cloud/networking/public-network/create.md
- src/content/docs/fr/public-cloud/compute/settings/ssh-keys.md
- src/content/docs/fr/public-cloud/compute/settings/port-forwarding.md
- src/content/docs/public-cloud/compute/settings/change-os.md
🚧 Files skipped from review as they are similar to previous changes (1)
- src/content/docs/public-cloud/compute/create-instance.md
- Created new documentation for operating systems including Ubuntu, Rocky Linux, Oracle Linux, Windows 11 Pro, and Windows Server. - Detailed information on each OS image, including default users, SSH access, first boot configuration, and available versions. - Updated the main operating systems index to include links to new documentation. - Improved clarity and consistency in the descriptions and instructions across all OS documentation. - Added notes on licensing for Windows images and emphasized the importance of providing valid licenses.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Why
Summary by CodeRabbit
New Features
Bug Fixes
rebootnow rejects non-Running VMs, andjson/yamloutput now returns full objects.Documentation