diff --git a/docs/docs/10-overview.md b/docs/docs/10-overview.md index 8b3469f63..cf5054407 100644 --- a/docs/docs/10-overview.md +++ b/docs/docs/10-overview.md @@ -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. diff --git a/docs/docs/20-quickstart.md b/docs/docs/20-quickstart.md index b14740eb0..f37187b65 100644 --- a/docs/docs/20-quickstart.md +++ b/docs/docs/20-quickstart.md @@ -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 @@ -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 kargo-demo: @@ -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 Freight Timeline 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 Freight Timeline, if it isn't there already. @@ -838,17 +838,17 @@ the previous section. 1. To promote `Freight` to the `test` `Stage`, select the target icon on the left border of test: - ![Kargo-Promote](../static/img/kargo-promote-option.png) + ![Kargo-Promote](./assets/kargo-promote-option.png) Next, select the `Freight` from the Freight Timeline and confirm the promotion by selecting Yes: - ![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 test, 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 @@ -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 diff --git a/docs/static/img/architecture.png b/docs/docs/assets/architecture.png similarity index 100% rename from docs/static/img/architecture.png rename to docs/docs/assets/architecture.png diff --git a/docs/static/img/argo-dashboard.png b/docs/docs/assets/argo-dashboard.png similarity index 100% rename from docs/static/img/argo-dashboard.png rename to docs/docs/assets/argo-dashboard.png diff --git a/docs/static/img/kargo-dashboard-projects.png b/docs/docs/assets/kargo-dashboard-projects.png similarity index 100% rename from docs/static/img/kargo-dashboard-projects.png rename to docs/docs/assets/kargo-dashboard-projects.png diff --git a/docs/static/img/kargo-dashboard-promotion.png b/docs/docs/assets/kargo-dashboard-promotion.png similarity index 100% rename from docs/static/img/kargo-dashboard-promotion.png rename to docs/docs/assets/kargo-dashboard-promotion.png diff --git a/docs/static/img/kargo-freight-verified.png b/docs/docs/assets/kargo-freight-verified.png similarity index 100% rename from docs/static/img/kargo-freight-verified.png rename to docs/docs/assets/kargo-freight-verified.png diff --git a/docs/static/img/kargo-frieght-timeline.png b/docs/docs/assets/kargo-frieght-timeline.png similarity index 100% rename from docs/static/img/kargo-frieght-timeline.png rename to docs/docs/assets/kargo-frieght-timeline.png diff --git a/docs/static/img/kargo-projects.png b/docs/docs/assets/kargo-projects.png similarity index 100% rename from docs/static/img/kargo-projects.png rename to docs/docs/assets/kargo-projects.png diff --git a/docs/static/img/kargo-promote-option-2.png b/docs/docs/assets/kargo-promote-option-2.png similarity index 100% rename from docs/static/img/kargo-promote-option-2.png rename to docs/docs/assets/kargo-promote-option-2.png diff --git a/docs/static/img/kargo-promote-option.png b/docs/docs/assets/kargo-promote-option.png similarity index 100% rename from docs/static/img/kargo-promote-option.png rename to docs/docs/assets/kargo-promote-option.png diff --git a/docs/docs/assets/kargo.png b/docs/docs/assets/kargo.png new file mode 100644 index 000000000..67bd6ad0a Binary files /dev/null and b/docs/docs/assets/kargo.png differ diff --git a/docs/static/img/logo.svg b/docs/docs/assets/logo.svg similarity index 100% rename from docs/static/img/logo.svg rename to docs/docs/assets/logo.svg diff --git a/docs/static/img/screenshot.png b/docs/docs/assets/screenshot.png similarity index 100% rename from docs/static/img/screenshot.png rename to docs/docs/assets/screenshot.png diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 58f8aec4f..28f574f15 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -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, @@ -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', diff --git a/docs/versioned_docs/version-1.0/10-overview.md b/docs/versioned_docs/version-1.0/10-overview.md new file mode 100644 index 000000000..cf5054407 --- /dev/null +++ b/docs/versioned_docs/version-1.0/10-overview.md @@ -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. + +
+
+