Skip to content

Updated documentation - #4

Open
wangerion wants to merge 2 commits into
cloudbase:mainfrom
wangerion:update_doc
Open

wangerion wants to merge 2 commits into
cloudbase:mainfrom
wangerion:update_doc

Conversation

@wangerion

Copy link
Copy Markdown

Every platform now lives in a specific directory to keep track more easily of md files. Created a new suse-linux-kvm-plugin.md file as a Work in progress file.

…ry to keep track more easily of md files. Created a new suse-linux-kvm-plugin.md file as a Work in progress file
@wangerion wangerion self-assigned this Oct 13, 2026
@wangerion
wangerion marked this pull request as ready for review October 15, 2026 11:26
@Cristi1324

Copy link
Copy Markdown

Review of 7dae88a (andrei/update_doc)

Checked against a clean make clean && make serve build (86 pages, 6 Sphinx warnings). The Platforms section renders, plugin images load, and links from a plugin page to its source and destination pages resolve. Old /plugins/ URLs return 404. The EULA move to https://cloudbase.it/coriolis-eula/ is accepted.

High

A current page sends the reader to a missing target.

  1. Every platform tile on Getting Started returns 404. source/guides/coriolis-getting-started.md still points at /plugins/... and the old flat /platforms/... paths.
  2. Six links stay on the same page. Sphinx reported each one:
    • source/walkthroughs/step-by-step-guide-vmware-to-openstack-migration.md (lines 175 and 189)
    • source/platform-notes/openstack-known-issues.md (line 44)
    • source/features/coriolis-shared-disks-migrations.md (line 12)
    • source/features/coriolis-minion-pools-operations-and-usage.md (line 98)
    • source/reference/coriolis-release-notes.md (line 655)

Medium

The new pages work. Older addresses and two platforms are hard to reach.

  1. Old public URLs have no redirect. /plugins/..., /platforms/aws-as-a-source-cloud.html, and /platforms/oracle-linux-virtualization-manager-as-a-destination-cloud.html return 404.
  2. Nutanix and CloudStack are absent from source/platforms/index.md. The pages exist and search finds them. The sidebar does not link to them.

Low

  1. OCI Classic is not published. The file is under source/deprecated/, and that directory is excluded from the build.
  2. Source and destination pages stay out of the sidebar and out of Previous/Next because they are marked orphan: true.
  3. source/platforms/suse-linux-kvm/suse-linux-kvm-plugin.md says the platform can be a source or a destination. The only links are the two destination pages, under WORK IN PROGRESS.

— Grok

@@ -43,11 +43,11 @@ Each parameter represents:

### AWS as a source cloud

For more information on using AWS as a **source cloud** for Replica/MIgration, please check the **[AWS as a source cloud](../platforms/aws-as-a-source-cloud.md)** page.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Replica/MIgration -> Replica/Migration
Please fix this typo everywhere.

@Cristi1324

Copy link
Copy Markdown

Cloudstack and Nutanix are still missing from the Platforms list

@Cristi1324

Copy link
Copy Markdown

LGTM!

This branch has not been deployed

No deployments
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