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

feat: versioned docs dropdown #3226

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion docs/docs/10-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ technologies, like [Argo CD](https://argoproj.github.io/cd/), to streamline and
automate the progressive rollout of changes across the many stages of an
application's lifecycle.

![Screenshot](../static/img/screenshot.png)
![Screenshot](./assets/screenshot.png)

Kargo's goal is to provide an intuitive and flexible layer "above" existing GitOps tooling, wherein you can describe the relationships between various application instances deployed to different environments as well as procedures for progressing changes from one application instance's source of truth to the next.

Expand Down
16 changes: 8 additions & 8 deletions docs/docs/20-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ all three Argo CD `Application`s have not yet synced because they're not
configured to do so automatically, and in fact, the branches referenced by their
`targetRevision` fields do not even exist yet.

![Argo-dashboard-screenshot](../static/img/argo-dashboard.png)
![Argo-dashboard-screenshot](./assets/argo-dashboard.png)

## Your First Kargo Project

Expand Down Expand Up @@ -787,7 +787,7 @@ the previous section.
This will take you to a list of `Project`s. It currently includes only
the one created in the previous step.

![Kargo-dashboard](../static/img/kargo-projects.png)
![Kargo-dashboard](./assets/kargo-projects.png)

1. Select <Hlt>kargo-demo</Hlt>:

Expand All @@ -801,13 +801,13 @@ the previous section.
* Three `Stage`s representing distinct instances of our demo
application.

![Kargo-dashboard-screenshot](../static/img/kargo-dashboard-projects.png)
![Kargo-dashboard-screenshot](./assets/kargo-dashboard-projects.png)

* An interactive <Hlt>Freight Timeline</Hlt> with `Freight` ordered
chronologically, with newer `Freight` to the left and older `Freight` to
the right.

![Kargo-Freight-Timeline](../static/img/kargo-frieght-timeline.png)
![Kargo-Freight-Timeline](./assets/kargo-frieght-timeline.png)

1. After a few seconds, a piece of `Freight` should appear in the <Hlt>Freight
Timeline</Hlt>, if it isn't there already.
Expand Down Expand Up @@ -838,17 +838,17 @@ the previous section.
1. To promote `Freight` to the `test` `Stage`, select the target icon on the
left border of <Hlt>test</Hlt>:

![Kargo-Promote](../static/img/kargo-promote-option.png)
![Kargo-Promote](./assets/kargo-promote-option.png)

Next, select the `Freight` from the <Hlt>Freight Timeline</Hlt> and confirm
the promotion by selecting <Hlt>Yes</Hlt>:

![Kargo-Promote](../static/img/kargo-promote-option-2.png)
![Kargo-Promote](./assets/kargo-promote-option-2.png)

When promotion process is complete, you'll see a check mark next to
<Hlt>test</Hlt>, indicating that the promotion was successful.

![Kargo-dashboard-screenshot](../static/img/kargo-dashboard-promotion.png)
![Kargo-dashboard-screenshot](./assets/kargo-dashboard-promotion.png)

Following the promotion, health checks will run periodically. When a `Stage`
is in a healthy state, this will be reflected with a heart icon. You can
Expand All @@ -868,7 +868,7 @@ the previous section.
`test`, which designates it as eligible for promotion to the next `Stage` --
in our case, `uat`.

![Kargo-Freight-Verified](../static/img/kargo-freight-verified.png)
![Kargo-Freight-Verified](./assets/kargo-freight-verified.png)

:::note
Although this example does not demonstrate it, it is also possible to verify
Expand Down
File renamed without changes
Binary file added docs/docs/assets/kargo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
7 changes: 6 additions & 1 deletion docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ const config = {
docs: {
sidebarPath: require.resolve('./sidebars.js'),
sidebarCollapsible: false,
routeBasePath: '/', // Serve the docs at the site's roo
routeBasePath: '/', // Serve the docs at the site's root
},
blog: false,
pages: false,
Expand Down Expand Up @@ -85,6 +85,11 @@ const config = {
label: 'Kargo.io',
position: 'left',
},
{
type: 'docsVersionDropdown',
position: 'right',
dropdownActiveClassDisabled: true,
},
{
href: 'https://github.com/akuity/kargo',
label: 'GitHub',
Expand Down
38 changes: 38 additions & 0 deletions docs/versioned_docs/version-1.0/10-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
slug: /
sidebar_label: Overview
description: Find out more about Kargo - a next-generation continuous delivery and application lifecycle orchestration platform for Kubernetes
---

# What is Kargo?

Kargo is a next-generation continuous delivery and application lifecycle
orchestration platform for Kubernetes. It builds upon
[GitOps](https://opengitops.dev/) principles and integrates with existing
technologies, like [Argo CD](https://argoproj.github.io/cd/), to streamline and
automate the progressive rollout of changes across the many stages of an
application's lifecycle.

![Screenshot](./assets/screenshot.png)

Kargo's goal is to provide an intuitive and flexible layer "above" existing GitOps tooling, wherein you can describe the relationships between various application instances deployed to different environments as well as procedures for progressing changes from one application instance's source of truth to the next.

:::info
Watch the *Multi-Stage Deployment Pipelines the GitOps Way* talk by Jesse Suen & Kent Rancourt of Akuity at GitOpsCon EU 2024.

<center>
<div style={{position: "relative", width: "100%", "padding-top": "56.25%"}}>
<iframe style={{position: "absolute", top: 0, left: 0, width: "100%", height: "100%"}} src="https://www.youtube.com/embed/0B_JODxyK0w" title="Kargo - Multi-Stage Deployment Pipelines using GitOps - Jesse Suen / Kent Rancourt" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen/>
</div>
</center>
:::

:::info
Join the Akuity Community [Discord server](https://discord.gg/dHJBZw6ewT)!
:::

## Next Steps

To learn more about Kargo, consider checking out our
[concepts doc](./concepts) or get hands-on right away with our
[quickstart](./quickstart)!
Loading
Loading