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

Update 2-core-concepts.md #846

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions docs/1-understand-the-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,40 @@

Before you are able to effectively use Zarf, it is useful to have an underlying understanding of the technology Zarf is built on and around. The sections below provide some helpful links to start building up this foundation as well as a glossary of the terms used in this project.

:::caution Hard Hat Area
This page is still being developed. More content will be added soon!
:::

<!-- TODO: This might be a good place to shamelessly plug the 'Air Gap' course -->
<!-- TODO: The links and information on this page need to be expanded a lot more to really be useful -->

<br />
<br />

## What is Kubernetes?
## Fundamental Technologies

### Kubernetes Basics

- [Kubernetes Overview](https://kubernetes.io/docs/concepts/overview/)
- [What is Kubernetes?](https://www.ibm.com/cloud/learn/kubernetes)
- [Learn Kubernetes Basics](https://kubernetes.io/docs/tutorials/kubernetes-basics/)
- [Free Introduction to Kubernetes Course](https://www.edx.org/course/introduction-to-kubernetes)
- [Super charge your Kubernetes deployments](https://www.youtube.com/watch?v=N6UCKF7JD7k)
<br />
<br />

## What is the 'Air Gap'?
### AirGap Basics

- [What is AirGap](https://ibm.github.io/kubernetes-networking/vpc/airgap/)
- AirGap Kubernetes Course - Coming Soon!

<br />
<br />

## What is GitOps?
## GitOps Basics

- [CloudBees GitOps Definition](https://www.cloudbees.com/gitops/what-is-gitops)
- [Understanding Git](https://hackernoon.com/understanding-git-fcffd87c15a3)

### CLI Basics

- [List of CLI Commands](https://www.codecademy.com/article/command-line-commands)
- [How to use the Command Line](https://training.linuxfoundation.org/training/linux-tools-for-software-development-lfd108x/)
- [Free Linux tools for Software Development Course](https://training.linuxfoundation.org/training/linux-tools-for-software-development-lfd108x/)

## Terms Used

Expand Down
6 changes: 2 additions & 4 deletions docs/2-core-concepts.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# Core Concepts

:::caution Hard Hat Area
This page is still being developed. More content will be added soon!
:::

Now, assuming you're familiar with Kubernetes, the AirGap, and GitOps from [Understanding the Basics](./1-understand-the-basics.md), we can get started on the core concepts of Zarf.

##Zarf Concepts

- [**Zarf Package**](./4-user-guide/2-zarf-packages/1-zarf-packages.md) - A binary file that contains the instructions and dependencies necessary to install an application on a system.
- [**Zarf Component**](./4-user-guide/2-zarf-packages/2-zarf-components.md) - A set of defined functionality and resources that build up a package.
- [**Zarf Init Package**](./4-user-guide/2-zarf-packages/3-the-zarf-init-package.md) - The initial package that lays the groundwork for other packages.