Skip to content
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

Fixed formatting warnings #460

Merged
merged 16 commits into from
Dec 19, 2024
Merged

Conversation

sp-techdocs
Copy link
Contributor

@sp-techdocs sp-techdocs commented Dec 16, 2024

Fixed several formatting issues, thus reducing the number of warnings reported during a Sphinx build from 1119 to 996.


📚 Documentation preview 📚: https://cloudstack-documentation--460.org.readthedocs.build/en/460/

Copy link
Contributor

@DaanHoogland DaanHoogland left a comment

Choose a reason for hiding this comment

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

looks good but needs "testing"

* Host1: h1
* Host2: h2
* Offering: h1

When a VM is created with the offering, the deployment will be carried out on Host1, as it is the one that has the tag compatible with the offering.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
When a VM is created with the offering, the deployment will be carried out on Host1, as it is the one that has the tag compatible with the offering.
When a VM is created with the offering, the deployment will be carried out on Host1, as it is the one that has the tag compatible with the offering.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The idea for indenting this paragraph was to make it a child element of the parent "#. Tag setup:" numbered list item. In the same way as the bulleted list above it is indented. This way both child elements look like belonging to the numbered list item.

For me, removing the indentation for this paragraph would lead to showing it as being at the same logical level as the numbered list item, looking like it is not related to it. And they are actually related.

Overall, it seems the four "#. Tag setup:" numbered list items here are not related, and it might be better to convert them to bulleted list items. While keeping their child content indented.

Copy link
Contributor

Choose a reason for hiding this comment

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

It is a paragraph under "#. Tag Setup", as I see it. and not related to the specific last of the tags mentioned above as it seemed to be before. The indentation is a bit overdone. Thanks anyway, I'm not going to stop these improvements over this.

* Host1: h1
* Host2: h2,h3
* Offering: h3

Hosts and offerings accept a list of tags, with comma (,) being their separator. So in this example, Host2 has the h2 and h3 tags. When a VM is created with the offering, the deployment will be carried out on Host2, as it is the one that has the tag compatible with the offering.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Hosts and offerings accept a list of tags, with comma (,) being their separator. So in this example, Host2 has the h2 and h3 tags. When a VM is created with the offering, the deployment will be carried out on Host2, as it is the one that has the tag compatible with the offering.
Hosts and offerings accept a list of tags, with comma (,) being their separator. So in this example, Host2 has the h2 and h3 tags. When a VM is created with the offering, the deployment will be carried out on Host2, as it is the one that has the tag compatible with the offering.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As above, it might be better to keep the indentation.

* Host1: h1
* Host2: h2,h3
* Offering: (no tag)

When the offering does not have tags, it will be possible to deploy the VM on any host.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
When the offering does not have tags, it will be possible to deploy the VM on any host.
When the offering does not have tags, it will be possible to deploy the VM on any host.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As above, it might be better to keep the indentation.

* Host1: (no tag)
* Host2: h2
* Offering: h3

None of the hosts have compatible tags and it will not be possible to deploy a VM with the offering. However, CloudStack ignores this behavior when a host is manually selected.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
None of the hosts have compatible tags and it will not be possible to deploy a VM with the offering. However, CloudStack ignores this behavior when a host is manually selected.
None of the hosts have compatible tags and it will not be possible to deploy a VM with the offering. However, CloudStack ignores this behavior when a host is manually selected.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As above, it might be better to keep the indentation.

* Storage: A
* Offering: A,B

Storage and offering accept a list of tags, with the comma (,) being their separator. Therefore, in this example, the offering has tags A and B. In this example, it will not be possible to allocate the volume, as all the offering tags must exist in the storage. Although the storage has the A tag, it does not have the B tag.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Storage and offering accept a list of tags, with the comma (,) being their separator. Therefore, in this example, the offering has tags A and B. In this example, it will not be possible to allocate the volume, as all the offering tags must exist in the storage. Although the storage has the A tag, it does not have the B tag.
Storage and offering accept a list of tags, with the comma (,) being their separator. Therefore, in this example, the offering has tags A and B. In this example, it will not be possible to allocate the volume, as all the offering tags must exist in the storage. Although the storage has the A tag, it does not have the B tag.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As above, it might be better to keep the indentation. And convert the numbered list to bulleted.

* Storage: A,B,C,D,X
* Offering: A,B,C

In this example, it will be possible to allocate the volume, as all the offering tags exist in the storage.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In this example, it will be possible to allocate the volume, as all the offering tags exist in the storage.
In this example, it will be possible to allocate the volume, as all the offering tags exist in the storage.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As above, it might be better to keep the indentation.

* Storage: A, B, C
* Offering: (no tag)

In this example, it will be possible to allocate the volume, as the offering does not have any tag requirements.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In this example, it will be possible to allocate the volume, as the offering does not have any tag requirements.
In this example, it will be possible to allocate the volume, as the offering does not have any tag requirements.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As above, it might be better to keep the indentation.

* Storage: (no tag)
* Offering: D,E

In this example, it will not be possible to allocate the volume, as the storage does not have tags, therefore it does not meet the offering requirements.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
In this example, it will not be possible to allocate the volume, as the storage does not have tags, therefore it does not meet the offering requirements.
In this example, it will not be possible to allocate the volume, as the storage does not have tags, therefore it does not meet the offering requirements.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As above, it might be better to keep the indentation.

Copy link
Contributor

@DaanHoogland DaanHoogland left a comment

Choose a reason for hiding this comment

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

some sugestions

@DaanHoogland DaanHoogland merged commit 310ae8a into apache:main Dec 19, 2024
1 check passed
@sp-techdocs sp-techdocs deleted the fixing-warnings branch December 19, 2024 14:19
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