citynetwork / docs Goto Github PK

This is simply an issue to remember that we miss theme-ing, and site names.

Summary

When I try to put a VM into rescue mode I get another type of rescue dialog then what is displayed in the documentation. The difference is that I have 3 options in the rescue dialog.

Documentation category

How-to guide

URL path

https://docs.cleura.cloud/howto/openstack/nova/rescue-server/

My suggestion

Update the last picture of the documentation.

Additional context

No response

Summary

The link to https://docs.scs.community/standards/scs-0102-v1-image-metadata/, which worked until 2023-08-22, has suddenly turned into a 404. This being a "stable" SCS standard, this probably should not happen.

Documentation category

Reference information

URL path

https://docs.cleura.cloud/reference/images/

My suggestion

The source for the image metadata standard is still available at https://github.com/SovereignCloudStack/standards/blob/main/Standards/scs-0102-v1-image-metadata.md. If the original link doesn't get fixed, maybe we should link to that page instead — although it would certainly be suboptimal.

IMO, pushes to a PR's branch should automatically discard votes on that PR.
WDYT?

Uploaded build is named build-version not build-version-SHA.

More a nuisance than anything, but fetching the artifacts results in file always having the same name. Having multiple filenames (one per sha) or (alternatively) having a way to view the artifacts direct from gh would help.

Summary

OpenStack>Cinder>Encrypted Volumes talks about adding adminsitrative user to access control list but the administrative user ID's are missing from the documentation.

Documentation category

How-to guide

URL path

https://docs.cleura.cloud/howto/openstack/cinder/encrypted-volumes/#block-device-encryption-caveats

My suggestion

I suggest Public Cloud Administrative User UUID's are added

Additional context

Since the reference to this is mentioned in one article linking to another I am unsure what would be the best place for this addition of information. I thought it's a decision and application best left to the maintainers of the project.

Summary

When trying to perform a rescue mode on a boot from volume server via CCMP it always returns back to Active state instead of going into rescue mode. If I run the CLI part of the documentation that works as expected.
When performing the same test on a server using Ephemeral disk it works fine.

URL path

https://docs.cleura.cloud/howto/openstack/nova/rescue-server/

What I did

Created a bfv server and followed the CCMP guide.

What I expected to observe

The server to go into rescue mode.

What I actually observed

The server only went back to Active state instead.

My environment

I am using Brave and Safari as Browser.
I have the issue with both Ubuntu and CentOS

Additional context

No response

Summary

The Getting Started guide for setting up REST API access talks about two-factor authentication, but the account creation guide doesn't cover it in detail.

Documentation category

How-to guide

URL path

https://docs.cleura.cloud/howto/getting-started/accessing-cc-rest-api/

My suggestion

In the REST API guide, we mention 2FA. However, in the account creation guide, we don't explain how to set it up.

The documentation should probably cover that (possibly in a separate guide), and also recommend it, since using 2FA is just good security practice.

Additional context

This issue exists primarily to test a GitHub-driven workflow for closing a documentation gap. But it also highlights a real documentation gap, so there's that. :)