feat: Added content for examples page #3355
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-kargo-io ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3355 +/- ##
=======================================
Coverage 52.47% 52.47%
=======================================
Files 291 291
Lines 26617 26617
=======================================
Hits 13968 13968
Misses 11886 11886
Partials 763 763 ☔ View full report in Codecov by Sentry. |
arober39
changed the title
arober39
changed the title
arober39
changed the title
Signed-off-by: Alexis Roberson <alexisroberson@Alexiss-Work-MacBook-Pro.local>
arober39
force-pushed
the
patch-example-page
branch
from
719b1ef to
5ab45b6
Compare
hiddeco
reviewed
Jan 24, 2025
Comment on lines
+11
to
+27
| ## Basic | ||
| ### Argo CD-Driven Examples | ||
| * [Argo CD Driven | Commit Only](https://github.com/akuity/kargo-examples/tree/main/01-argocd-driven/01-commit-only) | ||
| * [Argo CD Driven | Helm Driven | Chart Only](https://github.com/akuity/kargo-examples/tree/main/01-argocd-driven/02-helm-driven/01-chart-only) | ||
| * [Argo CD Driven | Helm Driven | Image only + Chart Repo](https://github.com/akuity/kargo-examples/tree/main/01-argocd-driven/02-helm-driven/02-image-only/01-with-chart-repo) | ||
| * [Argo CD Driven | Helm Driven | Image only + Git Repo](https://github.com/akuity/kargo-examples/tree/main/01-argocd-driven/02-helm-driven/02-image-only/02-with-git-repo) | ||
| * [Argo CD Driven | Helm Driven | Chart and Image](https://github.com/akuity/kargo-examples/tree/main/01-argocd-driven/02-helm-driven/03-chart-n-image) | ||
| * [Argo CD Driven | Helm Driven | Commit + Image](https://github.com/akuity/kargo-examples/tree/main/01-argocd-driven/02-helm-driven/04-commit-n-image) | ||
| * [Argo CD Driven | Kustomize Driven | Image only](https://github.com/akuity/kargo-examples/tree/main/01-argocd-driven/03-kustomize-driven/01-image-only) | ||
| * [Argo CD Driven | Kustomize Driven | Commit + Image](https://github.com/akuity/kargo-examples/tree/main/01-argocd-driven/03-kustomize-driven/02-commit-n-image) | ||
|
|
||
| ### Git Driven | ||
| * [Git Driven | Commit Only](https://github.com/akuity/kargo-examples/tree/main/02-git-driven/01-commit-only) | ||
| * [Git Driven | Helm Driven | Image Only](https://github.com/akuity/kargo-examples/tree/main/02-git-driven/02-helm-driven/01-image-only) | ||
| * [Git Driven | Helm Driven | Commit + Image](https://github.com/akuity/kargo-examples/tree/main/02-git-driven/02-helm-driven/02-commit-n-image) | ||
| * [Git Driven | Kustomize Driven | Image Only](https://github.com/akuity/kargo-examples/tree/main/02-git-driven/03-kustomize-driven/01-image-only) | ||
| * [Git Driven | Kustomize Driven | Commit + Image](https://github.com/akuity/kargo-examples/tree/main/02-git-driven/03-kustomize-driven/02-commit-n-image) |
There was a problem hiding this comment.
Instead of the | in the link titles, would it be an idea to simply create (sub-)headings?
There was a problem hiding this comment.
+1 I think that would be more orderly.
Also, since new features are being added all the time and because deprecations are a thing, I'm also wondering if we should maintain release-x.y branches for the examples like we do for Kargo itself, in which case, these links need to change to be version specific.
I know these examples are mostly based on examples in my personal krancour/examples repo. Note that I have updated those quite a bit since this snapshot of them you've got was taken.
krancour
reviewed
Jan 24, 2025
| Whether you're new to Kargo or looking to optimize your existing deployment pipelines, these examples will help you understand key concepts and implement powerful CD workflows. Each example includes detailed explanations, configuration files, and step-by-step guides to get you started. | ||
|
|
||
| ## Basic | ||
| ### Argo CD-Driven Examples |
There was a problem hiding this comment.
I think this whole section needs some kind of disclaimer.
See https://docs.kargo.io/new-docs/user-guide/patterns/#pseudo-gitops for explanation.
krancour
reviewed
Jan 24, 2025
| * [Git Driven | Kustomize Driven | Commit + Image](https://github.com/akuity/kargo-examples/tree/main/02-git-driven/03-kustomize-driven/02-commit-n-image) | ||
|
|
||
| ## Advanced | ||
| * [kargo-simple](https://github.com/akuity/kargo-simple) |
There was a problem hiding this comment.
Is it strange for an example with "simple" in its name to appear under the heading of "Advanced?"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As you can see, the page will be a collection of links to repos containing different examples. This is after discussing the final layout with @jessesuen in the google docs draft.
Signed-off-by: Alexis Roberson alexis.roberson@akuity.io