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 Zarf Features to Docs Overview pg. #632

Merged
merged 3 commits into from
Aug 23, 2022

Conversation

Madeline-UX
Copy link
Contributor

Description

Add a section on the Docs overview (home page) listing out the features of Zarf.

  • out of the box
  • configurable

Related Issue

  • New feature (non-breaking change which adds functionality)

Checklist before merging

  • Documentation has been updated as necessary (add the needs-docs label)

@Madeline-UX Madeline-UX linked an issue Jul 19, 2022 that may be closed by this pull request
@YrrepNoj YrrepNoj requested review from YrrepNoj and removed request for YrrepNoj July 21, 2022 17:05
@jeff-mccoy
Copy link
Member

We should tagup on this next week sometime, some of these features are a good fit, but I think some are too in the details and should be better summarized.

@Madeline-UX
Copy link
Contributor Author

@jeff-mccoy Sounds great. Will plan to discuss this during Tuesday's office hours.

@Madeline-UX
Copy link
Contributor Author

@jeff-mccoy Here is a working list of features that I have collected

📦 Out of the Box Features

  • Automates Kubernetes orchestration in disconnected environements.
  • Automates SBOM Generation
  • UI Dashboard for viewing SBOM findings
  • Deploy a cluster while fully disconnected (using K3s)
  • Deploy pre-built tar.zst package onto a machine or server (specifically into a k8s cluster)
  • Built in Logging
  • Seed Git Registry
  • Automatically update pod's ImagePullSecrets so deployed resources use the NodePort binding. See Zarf Agent.
  • K9 Dashboard for visualizing containers and clusters
  • Finds images and resources from helm chart
  • Creates secure tunnel ports for deployments

🛠️ Configurable Features

  • Manage CPU usage
  • Mount onto existing cluster
  • Customize packages variables

@YrrepNoj
Copy link
Member

@Madeline-UX Do you want to tag up this sometime this week? I'd love to help get this added to the docs.

And question for whenever we have time to talk; do we want to differentiate the features of 'Zarf the CLI' and 'the released Initialization Package'? The features listed above are a mix between the two which might be confusing for some.

@jeff-mccoy jeff-mccoy mentioned this pull request Aug 16, 2022
2 tasks
@Madeline-UX Madeline-UX force-pushed the 604-features-list-for-zarf-docswebpagemarketing branch from e4cdd00 to 6994a2c Compare August 17, 2022 21:36
@jeff-mccoy
Copy link
Member

Closing as these are covered by other PRs now.

@jeff-mccoy jeff-mccoy closed this Aug 22, 2022
@Madeline-UX Madeline-UX reopened this Aug 22, 2022
@Madeline-UX Madeline-UX marked this pull request as ready for review August 22, 2022 20:47
@Madeline-UX Madeline-UX force-pushed the 604-features-list-for-zarf-docswebpagemarketing branch 2 times, most recently from c4fcdce to f59c386 Compare August 22, 2022 22:42
@Madeline-UX Madeline-UX force-pushed the 604-features-list-for-zarf-docswebpagemarketing branch from f59c386 to 5f8b025 Compare August 22, 2022 22:50
@jeff-mccoy jeff-mccoy enabled auto-merge (squash) August 23, 2022 00:32
@jeff-mccoy jeff-mccoy merged commit 46a79cf into master Aug 23, 2022
@jeff-mccoy jeff-mccoy deleted the 604-features-list-for-zarf-docswebpagemarketing branch August 23, 2022 00:32
@Madeline-UX
Copy link
Contributor Author

@jeff-mccoy Is there a reason I am not seeing the merged changes updated on the Docs overview site?

Noxsios pushed a commit that referenced this pull request Mar 8, 2023
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.

Features list for Zarf (Docs/webpage/marketing)
3 participants