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

Add documentation and helpful links for downloading images #216

Open
yeazelm opened this issue Aug 17, 2023 · 1 comment
Open

Add documentation and helpful links for downloading images #216

yeazelm opened this issue Aug 17, 2023 · 1 comment
Labels
content-gap Missing pieces of documentation

Comments

@yeazelm
Copy link

yeazelm commented Aug 17, 2023

Path to page with content (do not include domain name): https://bottlerocket.dev/en/os/1.14.x/install/

What content is incorrect? It only sort of covers how to use the quickstarts. But for metal, I have to work through https://github.com/bottlerocket-os/bottlerocket/blob/develop/PROVISIONING-METAL.md#fetch-the-bottlerocket-image-for-bare-metal which has a lot of steps, including installing Rust and compiling tough from source. This involves multiple steps when all I want to do is download the image and try it on my hardware. See bottlerocket-os/bottlerocket#2779 for a deeper discussion on how this could be improved.

What should the content say or communicate?
Ideally, I would like to see as simple as possible process to get an image on my local machine. Many Linux distros have download links for their images. A list of URLs for each variant and version where I could click the button and download the image would be easiest. I would probably want a SHA sum next to the URL provided so I could verify I got the right image and its intact once downloaded.

An alternative that would still make things a lot better would be to provide a pre-build binary of tough (to avoid having to install Rust and then compile tough) and the website provide the full invocation for tough so the "hard work" is done for me of figuring out things like "metal-k8s-1.27" is what I want for the url for variant or what the latest version is at that moment in time.

@stockholmux stockholmux added the content-gap Missing pieces of documentation label Aug 17, 2023
@stockholmux
Copy link
Member

You're right. I think setting up Bottlerocket has several side quests. Not ideal. The website could be used to smooth the rough edges here; it's a substantial UX surface area.

The click-download-install workflow is somewhat of a user expectation for software which Bottlerocket doesn't have.

How folks feel about the implications of downloading w/o verification by tuftool is another question. @bcressey @etungsten @zmrow do you have thoughts on this?

I think all the currently supported platforms would need to be listed on a "downloads" page just so folks don't go down a confusing path thinking they need to download an image for EC2 or something.

[As for the alternative, making a pre-built binary of tough is out of scope for the website - but perhaps not the project at large - but even giving a straight-forward, copy-pastable way to use tuftool would be helpful.]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content-gap Missing pieces of documentation
Projects
None yet
Development

No branches or pull requests

2 participants