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 walkthrough update #1601

Merged
merged 13 commits into from
Apr 28, 2023
Merged

Zarf walkthrough update #1601

merged 13 commits into from
Apr 28, 2023

Conversation

laurenmengert
Copy link
Contributor

@laurenmengert laurenmengert commented Apr 14, 2023

Description

  • Updated the 'Using zarf package create' walkthrough
  • Changed both the 'Using zarf package create' and 'Deploying zarf packages' walkthroughs to use the helm-oci-chart example
  • Abstracted the dos games example from the 'create' and 'deploy' walkthroughs to create a full start to finish walkthrough
  • Fixed some grammar
  • Standardized some styling
  • Changed order of some pages (I wanted the full dos games walkthrough to come right after the 'deploying zarf packages' one. That seemed to make the most sense to me)

See comments section for some questions/requested feedback
...

Related Issue

Fixes #

Relates to #

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Other (security config, docs update, etc)

Checklist before merging

@netlify
Copy link

netlify bot commented Apr 14, 2023

Deploy Preview for zarf-docs ready!

Name Link
🔨 Latest commit fe470fc
🔍 Latest deploy log https://app.netlify.com/sites/zarf-docs/deploys/644bde654901d90008dd01b9
😎 Deploy Preview https://deploy-preview-1601--zarf-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@laurenmengert
Copy link
Contributor Author

  • Regarding the full Dos Games walkthrough - do we think I should add running zarf init? Do we want to make that a true walkthrough of every step, or is just the creation and deployment of the dos-games package enough?

  • I'd like opinions on whether or not we should keep the video walkthrough that is in the Dos-games section. That video only covers the deployment of the package, whereas the walkthrough article covers the creation and deployment

  • There was something else but I can't remember.. It will come to me and I'll make another comment or edit this one

@Racer159
Copy link
Contributor

  • Regarding the full Dos Games walkthrough - do we think I should add running zarf init? Do we want to make that a true walkthrough of every step, or is just the creation and deployment of the dos-games package enough?

    • I'd like opinions on whether or not we should keep the video walkthrough that is in the Dos-games section. That video only covers the deployment of the package, whereas the walkthrough article covers the creation and deployment

    • There was something else but I can't remember.. It will come to me and I'll make another comment or edit this one

I think linking init as a pre-req is fine and we can just focus on create/deploy.

IMO the dos-games video should likely be updated to include both create and deploy and more closely match the walkthrough.

(also there are merge conflicts on this branch that need to be resolved)

Copy link
Contributor

@Racer159 Racer159 left a comment

Choose a reason for hiding this comment

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

Just a few small suggestions.

docs/13-walkthroughs/2-deploying-zarf-packages.md Outdated Show resolved Hide resolved
docs/13-walkthroughs/2-deploying-zarf-packages.md Outdated Show resolved Hide resolved
docs/13-walkthroughs/2-deploying-zarf-packages.md Outdated Show resolved Hide resolved
@Racer159
Copy link
Contributor

Also looks like there are a few broken links as well
image

@Madeline-UX
Copy link
Contributor

  • Regarding the full Dos Games walkthrough - do we think I should add running zarf init? Do we want to make that a true walkthrough of every step, or is just the creation and deployment of the dos-games package enough?

    • I'd like opinions on whether or not we should keep the video walkthrough that is in the Dos-games section. That video only covers the deployment of the package, whereas the walkthrough article covers the creation and deployment
    • There was something else but I can't remember.. It will come to me and I'll make another comment or edit this one

I think linking init as a pre-req is fine and we can just focus on create/deploy.

IMO the dos-games video should likely be updated to include both create and deploy and more closely match the walkthrough.

(also there are merge conflicts on this branch that need to be resolved)

I have thought about this some - I think if we were to provide the game as pre-built (on release page) it could all be in one. I struggle with the walkthrough being build and deploy because for a lot of users those tasks will be separate. Although I know package creators will deploy to test. I think the bigger issue is the dos games is an example package. So this should really be how to build a package and how to deploy a package (general steps for packages)

@Racer159
Copy link
Contributor

  • Regarding the full Dos Games walkthrough - do we think I should add running zarf init? Do we want to make that a true walkthrough of every step, or is just the creation and deployment of the dos-games package enough?

    • I'd like opinions on whether or not we should keep the video walkthrough that is in the Dos-games section. That video only covers the deployment of the package, whereas the walkthrough article covers the creation and deployment
    • There was something else but I can't remember.. It will come to me and I'll make another comment or edit this one

I think linking init as a pre-req is fine and we can just focus on create/deploy.
IMO the dos-games video should likely be updated to include both create and deploy and more closely match the walkthrough.
(also there are merge conflicts on this branch that need to be resolved)

I have thought about this some - I think if we were to provide the game as pre-built (on release page) it could all be in one. I struggle with the walkthrough being build and deploy because for a lot of users those tasks will be separate. Although I know package creators will deploy to test. I think the bigger issue is the dos games is an example package. So this should really be how to build a package and how to deploy a package (general steps for packages)

I agree though I think I'd like to see #758 done first to really build that out - we have the dos games available via sget but this is not likely to be something that most people use as the OCI functionality is much easier for most to use.

@Racer159 Racer159 enabled auto-merge (squash) April 28, 2023 14:58
@Racer159 Racer159 merged commit 52f9ddd into main Apr 28, 2023
@Racer159 Racer159 deleted the zarf-walkthrough-update branch April 28, 2023 15: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.

3 participants