Updated documentation by wangerion · Pull Request #4 · cloudbase/coriolis-docs

wangerion · 2026-10-13T10:02:38Z

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.

Cristi1324 · 2026-10-15T12:15:43Z

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.

Every platform tile on Getting Started returns 404. source/guides/coriolis-getting-started.md still points at /plugins/... and the old flat /platforms/... paths.
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.

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.
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

OCI Classic is not published. The file is under source/deprecated/, and that directory is excluded from the build.
Source and destination pages stay out of the sidebar and out of Previous/Next because they are marked orphan: true.
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

Cristi1324 · 2026-10-16T12:49:23Z

Cloudstack and Nutanix are still missing from the Platforms list

Cristi1324 · 2026-10-16T14:47:53Z

LGTM!

…ry to keep track more easily of md files. Created a new suse-linux-kvm-plugin.md file as a Work in progress file

Dany9966 · 2026-11-04T13:44:10Z

+
+**Coriolis** integrates the platform Plugin on the Appliance itself, this way there is no need for agents to be deployed on platforms to establish the communication between the platform and the Coriolis components. Using this type of architecture, **Coriolis** guarantees the connection to the supported platform set up to be used as either Source or Destination, as long as the requirements are met.
+
+## WORK IN PROGRESS


This is not mergeable. Please complete the doc if you have anything else to add or remove this line.

Dany9966 · 2026-11-04T13:47:07Z

+
+**Coriolis** integrates the platform Plugin on the Appliance itself, this way there is no need for agents to be deployed on platforms to establish the communication between the platform and the Coriolis components. Using this type of architecture, **Coriolis** guarantees the connection to the supported platform set up to be used as either Source or Destination, as long as the requirements are met.
+
+## WORK IN PROGRESS


Same as above.

Dany9966 · 2026-11-04T13:48:37Z

+
+**Coriolis** integrates the platform Plugin on the Appliance itself, this way there is no need for agents to be deployed on platforms to establish the communication between the platform and the Coriolis components. Using this type of architecture, **Coriolis** guarantees the connection to the supported platform set up to be used as either Source or Destination, as long as the requirements are met.
+
+## WORK IN PROGRESS


Same as above.

Cristi1324

Review, model: Grok 4.7

1 high, 1 medium, 1 low. 3 confirmed, 0 suspected.

Not approved.

Reviewed at 6254b315bc5336a222d275deb17f2495cb018979. AI agents wrote these findings, and a person chose to post them. Suspected findings are unproven. Findings on the diff are inline comments.

get_provider keeps a provider only when cls.platform == platform_name. PLATFORM_STACKIT is stackit. The medium finding is the three comments Dany9966 already wrote.

Tested

sphinx-build -M html source build with Sphinx 9.1.0 and myst-parser 5.1.0 built commit 6254b315bc5336a222d275deb17f2495cb018979. The build wrote 88 source files. The warning log was empty. Every internal HTML and image link resolved. All 34 platform links on the Getting Started page resolved.
coriolis_provider_stackit/common.py:41 sets PLATFORM_STACKIT = "stackit". imp.py:43 and exp.py:40 assign that value to platform. coriolis/providers/factory.py:74 uses cls.platform == platform_name.
A second sphinx-build -M html source build after the three required edits succeeded. The warning log was empty. The STACKIT cell rendered stackit. WORK IN PROGRESS was absent. The Proxmox sentence rendered Replica/Migration.

Not run

A GitHub Pages deploy.
A coriolis command with --provider STACKIT.

Skippable

Old public URLs have no redirect. This review does not require one.

Withdrawn

The walkthrough link http://openstack-coriolis-plugin is handled by #8.

Cristi1324 · 2026-11-06T14:26:58Z

-Plugin identifier| **stackit**|  Identifies the plugin. Used for the **–provider** CLI parameter  
-Credentials needed| Stackit organization, project, region and service account key.| The service account key is expected to be base64 encoded.  
-Deployment requirements| Coriolis worker component(s) need network access to the Stackit API endpoint.| Coriolis deployment and environment connectivity requirements  
+Plugin identifier| **STACKIT**|  Identifies the plugin. Used for the **–provider** CLI parameter  


High · confirmed · The table tells the reader to pass STACKIT to --provider.

The diff changes the plugin identifier from stackit to STACKIT. get_provider accepts only an exact match with stackit, so STACKIT raises NotFound.

Why

The provider id is stackit.

Added

The identifier cell is stackit.

Evidence

stackit-coriolis-plugin.md:59 writes **STACKIT**. coriolis_provider_stackit/common.py:41 sets PLATFORM_STACKIT to stackit. imp.py:43 and exp.py:40 assign that value to platform. coriolis/providers/factory.py:74 compares cls.platform == platform_name and raises NotFound when the strings differ.

Proposed fix (version 1 of 1, accepted)

This version writes stackit in the identifier cell. The en dash and the two trailing spaces stay.

Suggested change (accepted)

Suggested change

Plugin identifier| **STACKIT**| Identifies the plugin. Used for the **–provider** CLI parameter

Plugin identifier| **stackit**| Identifies the plugin. Used for the **–provider** CLI parameter

Discussion with the review agent

Version 1 of 1 was accepted.

_{model: Grok 4.7}

This was a very good catch

Cristi1324 · 2026-11-06T14:26:58Z

+
+## WORK IN PROGRESS
+


Medium · confirmed · The page adds a WORK IN PROGRESS heading.

The diff adds ## WORK IN PROGRESS on line 9. Dany9966 wrote: "This is not mergeable. Please complete the doc if you have anything else to add or remove this line."

Why

Dany9966 said this line is not mergeable.

Added

The WORK IN PROGRESS heading is removed.

Evidence

cloudstack-coriolis-plugin.md:9 is ## WORK IN PROGRESS. Dany9966 wrote that sentence on this line on 4 Nov 2026.

Proposed fix (version 2 of 2, accepted)

This version removes the WORK IN PROGRESS heading. It adds no other text. Lines 8–10 become one blank line.

Suggested change (accepted)

Suggested change

## WORK IN PROGRESS

Discussion with the review agent

Version 1 added that the Platforms list publishes the page. That version was not accepted. Version 2 of 2 removes the heading and adds no other text. Version 2 was accepted.

_{model: Grok 4.7}

Cristi1324 · 2026-11-06T14:26:58Z

+
+## WORK IN PROGRESS
+


Medium · confirmed · The page adds a WORK IN PROGRESS heading.

The diff adds ## WORK IN PROGRESS on line 9. Dany9966 wrote: "Same as above."

Why

Dany9966 said this line is not mergeable.

Added

The WORK IN PROGRESS heading is removed.

Evidence

nutanix-coriolis-plugin.md:9 is ## WORK IN PROGRESS. Dany9966 wrote "Same as above." on this line on 4 Nov 2026. That refers to the CloudStack comment: "This is not mergeable. Please complete the doc if you have anything else to add or remove this line."

Proposed fix (version 2 of 2, accepted)

This version removes the WORK IN PROGRESS heading. It adds no other text. Lines 8–10 become one blank line.

Suggested change (accepted)

Suggested change

## WORK IN PROGRESS

Discussion with the review agent

Version 1 added that the Platforms list publishes the page. That version was not accepted. Version 2 of 2 removes the heading and adds no other text. Version 2 was accepted.

_{model: Grok 4.7}

Cristi1324 · 2026-11-06T14:26:58Z

+
+## WORK IN PROGRESS
+


Medium · confirmed · The page adds a WORK IN PROGRESS heading.

The diff adds ## WORK IN PROGRESS on line 9. Dany9966 wrote: "Same as above."

Why

Dany9966 said this line is not mergeable.

Added

The WORK IN PROGRESS heading is removed.

Evidence

suse-linux-kvm-plugin.md:9 is ## WORK IN PROGRESS. Dany9966 wrote "Same as above." on this line on 4 Nov 2026. That refers to the CloudStack comment: "This is not mergeable. Please complete the doc if you have anything else to add or remove this line."

Proposed fix (version 2 of 2, accepted)

This version removes the WORK IN PROGRESS heading. It adds no other text. Lines 8–10 become one blank line.

Suggested change (accepted)

Suggested change

## WORK IN PROGRESS

Discussion with the review agent

Version 1 added that the Platforms list publishes the page. That version was not accepted. Version 2 of 2 removes the heading and adds no other text. Version 2 was accepted.

_{model: Grok 4.7}

Cristi1324 · 2026-11-06T14:26:58Z

 ### Proxmox as a destination cloud

-For more information on using Proxmox as a **destination cloud** for Replica/MIgration, please check the **[Proxmox as a destination cloud](../platforms/proxmox-as-a-destination-cloud.md)** page.
+For more information on using Proxmox as a **destination cloud** for Replica/MIgration, please check the **[Proxmox as a destination cloud](../proxmox/proxmox-as-a-destination-cloud.md)** page.


Low · confirmed · The Proxmox page keeps the spelling Replica/MIgration.

The diff updates the link on this line and leaves Replica/MIgration. The VMware and AWS lines in the same diff use Replica/Migration.

Why

The same diff already uses Replica/Migration.

Added

The word is Replica/Migration.

Evidence

proxmox-coriolis-plugin.md:16 says Replica/MIgration. The built page contains that spelling. The VMware and AWS plugin lines in this diff say Replica/Migration.

Proposed fix (version 1 of 1, accepted)

This version replaces Replica/MIgration with Replica/Migration on this line.

Suggested change (accepted)

Suggested change

For more information on using Proxmox as a **destination cloud** for Replica/MIgration, please check the **[Proxmox as a destination cloud](../proxmox/proxmox-as-a-destination-cloud.md)** page.

For more information on using Proxmox as a **destination cloud** for Replica/Migration, please check the **[Proxmox as a destination cloud](../proxmox/proxmox-as-a-destination-cloud.md)** page.

Discussion with the review agent

Version 1 of 1 was accepted.

_{model: Grok 4.7}

wangerion requested review from Dany9966 and petrutlucian94 October 13, 2026 10:02

wangerion self-assigned this Oct 13, 2026

wangerion marked this pull request as ready for review October 15, 2026 11:26

Cristi1324 reviewed Oct 16, 2026

View reviewed changes

Comment thread source/platforms/amazon-web-services-aws/amazon-web-services-aws-coriolis-plugin.md Resolved

wangerion force-pushed the update_doc branch from 7834fc7 to 6926bbe Compare October 16, 2026 13:48

Cristi1324 approved these changes Oct 16, 2026

View reviewed changes

wangerion added 2 commits November 4, 2026 13:21

Updated documentation, every platform now lives in a specific directo…

a9228d6

…ry to keep track more easily of md files. Created a new suse-linux-kvm-plugin.md file as a Work in progress file

Fixed wrong linked md files.

6254b31

wangerion force-pushed the update_doc branch from 6926bbe to 6254b31 Compare November 4, 2026 11:23

Dany9966 requested changes Nov 4, 2026

View reviewed changes

Cristi1324 suggested changes Nov 6, 2026

View reviewed changes


		Coriolis integrates the platform Plugin on the Appliance itself, this way there is no need for agents to be deployed on platforms to establish the communication between the platform and the Coriolis components. Using this type of architecture, Coriolis guarantees the connection to the supported platform set up to be used as either Source or Destination, as long as the requirements are met.

		## WORK IN PROGRESS

	Plugin identifier\| STACKIT\| Identifies the plugin. Used for the –provider CLI parameter
	Plugin identifier\| stackit\| Identifies the plugin. Used for the –provider CLI parameter

	For more information on using Proxmox as a destination cloud for Replica/MIgration, please check the [Proxmox as a destination cloud](../proxmox/proxmox-as-a-destination-cloud.md) page.
	For more information on using Proxmox as a destination cloud for Replica/Migration, please check the [Proxmox as a destination cloud](../proxmox/proxmox-as-a-destination-cloud.md) page.

Conversation

wangerion commented Oct 13, 2026

Uh oh!

Cristi1324 commented Oct 15, 2026

High

Medium

Low

Uh oh!

Uh oh!

Cristi1324 commented Oct 16, 2026

Uh oh!

Cristi1324 commented Oct 16, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Cristi1324 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants