Public cloud: Move a how-to guide from a specific cloud to a more generic location

[k-dimple]

GitHub repo: https://github.com/canonical/ubuntu-cloud-docs

The repo contains multiple projects (one per cloud and a generic one called 'all-clouds'). A specific how-to guide under the 'google' project (Check if your Ubuntu image has addressed a CVE) needs to be moved to the 'all-clouds' project since the instructions in the how-to guide are generic and applicable to all clouds.

[activus-d]

@k-dimple I'd like to work on this issue.

[k-dimple]

Sure @activus-d that'll be great! Please give it a go and let me know if you have any questions.

The 'all-clouds' project does not include a 'how-to' section and we won't be creating that till we get more content. So currently you can add this how-to guide to the main list of content that you see on the left navigation bar on the published version of all-clouds

[k-dimple]

Also @activus-d, you might want to check out the contribution guidelines for these projects in case it helps:

• How to contribute to the 'all-clouds' project
• How to contribute to the 'google' project

[activus-d]

Also @activus-d, you might want to check out the contribution guidelines for these projects in case it helps:

• How to contribute to the 'all-clouds' project
• How to contribute to the 'google' project

They will surely be helpful. Thanks for sharing @k-dimple

[activus-d]

@k-dimple While trying to run checks on the new changes I made to the documentation, the PROJECT=all-clouds make woke command prompted me to enter a password:

Installing "woke" snap... 

Password:

I'm unaware of the exact password to enter.

[k-dimple]

Assuming that you are running the checks on your local machine, it should be the password of the logged in user (i.e. you?). Just use the password that you would use whenever you try to install any package.

[activus-d]

Yes, I was running the checks on my local machine and used my password but got the error:

Installing "woke" snap... 

Password:
sudo: snap: command not found
make: *** [woke-install] Error 1

Subsequently, I downloaded Snapcraft by following the instructions on Install snapcraft on macOS. I then rerun the PROJECT=all-clouds make woke command, but got the error:

Installing "woke" snap... 

Password:
Interacting with snapd is not yet supported on darwin.
This command has been left available for documentation purposes only.
make: *** [woke-install] Error 1

My findings from this Snapcraft forum show that Snapcraft is not supported by my macOS and may be interfering with running the PROJECT=all-clouds make woke command. Do you think I should make a PR regardless? I would also appreciate any help I can get with solving the issue.

[k-dimple]

Yeah, I think you can go ahead and create the PR. All the tests (including woke) will anyway run as part of the PR checks.

@degville would you be able to help with the above issue (related to installing snaps on MacOS) that @activus-d is facing?

[degville]

@degville would you be able to help with the above issue (related to installing snaps on MacOS) that @activus-d is facing?

Yes, of course. I know what the problem is - I'll try and have a closer look later. Thanks for including me!

[degville]

@degville would you be able to help with the above issue (related to installing snaps on MacOS) that @activus-d is facing?

Yes, of course. I know what the problem is - I'll try and have a closer look later. Thanks for including me!

I don't think there's a quick fix for this. Our Makefile only currently installs woke from its snap, which precludes non-snap-capable systems including macOS and Windows. There are other installation methods for woke (brew on macOS, for example). But I think the best solution is likely to move away from woke completely, and incorporate its wordlist into aspell or some of our other tooling. This may even be a good task for the Academy.