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

Existing walkthrough cleanup #1377

Closed
3 of 4 tasks
Racer159 opened this issue Feb 21, 2023 · 3 comments · Fixed by #1456, #1462 or #1470
Closed
3 of 4 tasks

Existing walkthrough cleanup #1377

Racer159 opened this issue Feb 21, 2023 · 3 comments · Fixed by #1456, #1462 or #1470
Assignees
Labels
documentation 📘 Improvements or additions to documentation
Milestone

Comments

@Racer159
Copy link
Contributor

Racer159 commented Feb 21, 2023

Describe what should be investigated or refactored

We need to cleanup our existing walkthroughs on docs.zarf.dev to match the new style of walkthrough bein introduced via the Big Bang component and the OCI publish PRs

Links to any relevant code

https://github.com/defenseunicorns/zarf/tree/main/docs/13-walkthroughs
https://github.com/defenseunicorns/zarf/blob/bigbang-component/docs/13-walkthroughs/5-big-bang.md

Walkthroughs to be updated

Additional context

Our existing PRs are confusing and do not match the tone or style that we wish of the Zarf project. This should be fixed so that people have an excellent introduction to using Zarf and these can be used more to help people learn about and use Zarf

@Racer159
Copy link
Contributor Author

Racer159 commented Mar 3, 2023

@Racer159 Racer159 changed the title Walkthrough cleanup Existing walkthrough cleanup Mar 3, 2023
@Madeline-UX Madeline-UX moved this from New Requests to To Do in Zarf Project Board Mar 3, 2023
@Madeline-UX Madeline-UX added this to the v0.25.x milestone Mar 3, 2023
@Racer159
Copy link
Contributor Author

Racer159 commented Mar 4, 2023

Something that would be really nice to do where we are showing Zarf console output in walkthroughs would be to use a tool like ansi2html (https://github.com/kilobyte/colorized-logs) to capture it. This would render as text the same size as the instructions and would be copy/pasteable and should still have colors in our docs site.

- name: GIT_SERVER_CPU_REQ
  description: The CPU request for git server
  default: 200m
- name: GIT_SERVER_MEM_REQ
  description: The memory request for git server
  default: 512Mi
- name: GIT_SERVER_CPU_LIMIT
  description: The CPU limit for git server
  default: "3"
- name: GIT_SERVER_MEM_LIMIT
  description: The memory limit for git server
  default: 2Gi
constants:
- name: AGENT_IMAGE
  value: agent:local
This package has 9 artifacts with software bill-of-materials (SBOM) included. You can view them now
in the zarf-sbom folder in this directory or to go directly to one, open this in your browser:
/home/wayne/workspace/zarf/zarf-sbom/sbom-viewer-docker.io_grafana_promtail_2.7.0.html

* This directory will be removed after package deployment.

?  Deploy this Zarf package? (y/N) 

image

Not a requirement for this issue, but something that would add a bit to the docs as people go through them. It would also be editable so that if one small part of verbiage updated you wouldn't need to run through a whole walkthrough just to get to that section to retake a good screenshot.

@JasonvanBrackel
Copy link
Contributor

@Racer159 ☝️

Racer159 added a commit that referenced this issue Mar 21, 2023
## Description

Uses the new walkthrough format, and includes a new embedded YouTube
video.

## Related Issue

Partially Fixes #1377 

## Type of change

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

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Co-authored-by: Wayne Starr <[email protected]>
@github-project-automation github-project-automation bot moved this from To Do to Done in Zarf Project Board Mar 21, 2023
Racer159 added a commit that referenced this issue Mar 23, 2023
## Description

Updates the doom walkthrough to use colored ansi output

## Related Issue

Partially Fixes #1377
<!-- or -->
Relates to #

## Type of change

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

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Co-authored-by: Wayne Starr <[email protected]>
Co-authored-by: razzle <[email protected]>
Racer159 added a commit that referenced this issue Mar 23, 2023
## Description

Changes the logging walkthrough to fit the new walkthrough template

## Related Issue

Partially Fixes #1377

## Type of change

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

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Co-authored-by: Wayne Starr <[email protected]>
Co-authored-by: razzle <[email protected]>
This was referenced Mar 29, 2023
Racer159 added a commit that referenced this issue Apr 5, 2023
## Description
Updates to "Initializing a K8s Cluster" and "Creating a k8s Cluster with
Zarf" Walkthroughs
...

## Related Issue

Partial fix for #1377 

## Type of change

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

## Checklist before merging

- [X] Test, docs, adr added or updated as needed
- [X] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

---------

Co-authored-by: Wayne Starr <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📘 Improvements or additions to documentation
Projects
None yet
5 participants