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

Zarf Getting started docs should include zarf-init download #125

Closed
andrewg-xyz opened this issue Oct 27, 2021 · 2 comments · Fixed by #127
Closed

Zarf Getting started docs should include zarf-init download #125

andrewg-xyz opened this issue Oct 27, 2021 · 2 comments · Fixed by #127
Assignees

Comments

@andrewg-xyz
Copy link
Contributor

Include zarf-init.tar.zst download in https://github.com/defenseunicorns/zarf/tree/master/examples/game#get-ready

@btlghrants
Copy link
Contributor

Just had a chat w/ @andrewsgreene about his experience & uncovered a couple nuggets that'll help us close out this issue:

  • While the steps describing how to install a Zarf release (on the "Workstation Setup" page) do include "zarf-init.tar.zst", the way they're formatted is pretty poor--they're presented in such a way that the reader's eye just sort of skips over the "zarf-init.tar.zst". They need to be re-ordered / re-formatted to make the important bits stand out more.

  • In addition to clarifying the install instructions, we should also add a note to the "Get Started" page's "Get Ready" step that mentions how multiple files are included as part of a Zarf release. This'll help prime the reader to see the tar.zst download instruction once they move over to the install instructions.

  • It would also be worth adding a mention to the specific error received when a tar.zst is not found & how to fix it (i.e. have a tar.zst file) in the "Get Started" page's "Create a cluster" step. This would help catch download issues AND cases where someone did download the .tar.zst and just forgot to put it in the right folder.

@btlghrants btlghrants self-assigned this Oct 27, 2021
@btlghrants
Copy link
Contributor

btlghrants commented Oct 27, 2021

I'm going to put some work in on this this morning under the umbrella of Issue #47 (same issue we put PR #124 "Get Started" example rewrite under).

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 a pull request may close this issue.

2 participants