From b87a5b469961c81e0afe27b8a96a34656874a9ba Mon Sep 17 00:00:00 2001 From: Yoshiki Fujikane <40124947+ffjlabo@users.noreply.github.com> Date: Mon, 6 Nov 2023 16:13:54 +0900 Subject: [PATCH] Update docs for overview (#4655) * update overview Signed-off-by: Yoshiki Fujikane * Fix docs Signed-off-by: Yoshiki Fujikane --------- Signed-off-by: Yoshiki Fujikane --- docs/content/en/docs-dev/faq/_index.md | 12 ++++++++++++ docs/content/en/docs-dev/overview/_index.md | 15 ++++++++++++++- docs/content/en/docs-v0.45.x/faq/_index.md | 12 ++++++++++++ docs/content/en/docs-v0.45.x/overview/_index.md | 15 ++++++++++++++- 4 files changed, 52 insertions(+), 2 deletions(-) diff --git a/docs/content/en/docs-dev/faq/_index.md b/docs/content/en/docs-dev/faq/_index.md index 1a58110ddd..ce6896875c 100644 --- a/docs/content/en/docs-dev/faq/_index.md +++ b/docs/content/en/docs-dev/faq/_index.md @@ -49,3 +49,15 @@ Yes, you can use PipeCD for both mesh (Istio, SMI) applications and non-mesh app ### 6. What should I do if I lost my Piped key? You can create a new Piped key. Go to the `Piped` tab at `Settings` page, and click the vertical ellipsis of the Piped that you would like to create the new Piped key. Don't forget deleting the old Key, too. + +### 7. What is the strong point if PipeCD is used only for Kubernetes? + +- Simple interface, easy to understand no extra CRD required +- Easy to install, upgrade, and manage (both the ControlPlane and the agent Piped) +- Not strict depend on any Kubernetes API, not being part of issues for your Kubernetes cluster versioning upgrade +- Easy to interact with any CI; Plan preview feature gives you an early look at what will be changed in your cluster even before manifests update +- Insights show metrics like lead time, deployment frequency, MTTR, and change failure rate to measure delivery performance + +### 8. Is it open source? + +Yes, PipeCD is fully open source project with APACHE LICENSE, VERSION 2.0!! diff --git a/docs/content/en/docs-dev/overview/_index.md b/docs/content/en/docs-dev/overview/_index.md index 3ab0953ae8..9fbaf09e67 100644 --- a/docs/content/en/docs-dev/overview/_index.md +++ b/docs/content/en/docs-dev/overview/_index.md @@ -19,6 +19,17 @@ PipeCD provides a unified continuous delivery solution for multiple application ## Why PipeCD? +- Simple, unified and easy to use but powerful pipeline definition to construct your deployment +- Same deployment interface to deploy applications of any platform, including Kubernetes, Terraform, GCP Cloud Run, AWS Lambda, AWS ECS +- No CRD or applications' manifest changes are required; Only need a pipeline definition along with your application manifests +- No deployment credentials are exposed or required outside the application cluster +- Built-in deployment analysis as part of the deployment pipeline to measure impact based on metrics, logs, emitted requests +- Easy to interact with any CI; The CI tests and builds artifacts, PipeCD takes the rest +- Insights show metrics like lead time, deployment frequency, MTTR and change failure rate to measure delivery performance +- Designed to manage thousands of cross-platform applications in multi-cloud for company scale but also work well for small projects + +## PipeCD's Characteristics in detail + **Visibility** - Deployment pipeline UI shows clarify what is happening - Separate logs viewer for each individual deployment @@ -50,7 +61,9 @@ PipeCD provides a unified continuous delivery solution for multiple application ## Where should I go next? -For a good understanding of the PipeCD's components, see the [Concepts](../concepts) page. +For a good understanding of the PipeCD's components. +- [Concepts](../concepts): describes each components. +- [FAQ](../faq): describes the difference between PipeCD and other tools. If you are an **operator** wanting to install and configure PipeCD for other developers. - [Quickstart](../quickstart/) diff --git a/docs/content/en/docs-v0.45.x/faq/_index.md b/docs/content/en/docs-v0.45.x/faq/_index.md index 1a58110ddd..ce6896875c 100644 --- a/docs/content/en/docs-v0.45.x/faq/_index.md +++ b/docs/content/en/docs-v0.45.x/faq/_index.md @@ -49,3 +49,15 @@ Yes, you can use PipeCD for both mesh (Istio, SMI) applications and non-mesh app ### 6. What should I do if I lost my Piped key? You can create a new Piped key. Go to the `Piped` tab at `Settings` page, and click the vertical ellipsis of the Piped that you would like to create the new Piped key. Don't forget deleting the old Key, too. + +### 7. What is the strong point if PipeCD is used only for Kubernetes? + +- Simple interface, easy to understand no extra CRD required +- Easy to install, upgrade, and manage (both the ControlPlane and the agent Piped) +- Not strict depend on any Kubernetes API, not being part of issues for your Kubernetes cluster versioning upgrade +- Easy to interact with any CI; Plan preview feature gives you an early look at what will be changed in your cluster even before manifests update +- Insights show metrics like lead time, deployment frequency, MTTR, and change failure rate to measure delivery performance + +### 8. Is it open source? + +Yes, PipeCD is fully open source project with APACHE LICENSE, VERSION 2.0!! diff --git a/docs/content/en/docs-v0.45.x/overview/_index.md b/docs/content/en/docs-v0.45.x/overview/_index.md index 3ab0953ae8..9fbaf09e67 100644 --- a/docs/content/en/docs-v0.45.x/overview/_index.md +++ b/docs/content/en/docs-v0.45.x/overview/_index.md @@ -19,6 +19,17 @@ PipeCD provides a unified continuous delivery solution for multiple application ## Why PipeCD? +- Simple, unified and easy to use but powerful pipeline definition to construct your deployment +- Same deployment interface to deploy applications of any platform, including Kubernetes, Terraform, GCP Cloud Run, AWS Lambda, AWS ECS +- No CRD or applications' manifest changes are required; Only need a pipeline definition along with your application manifests +- No deployment credentials are exposed or required outside the application cluster +- Built-in deployment analysis as part of the deployment pipeline to measure impact based on metrics, logs, emitted requests +- Easy to interact with any CI; The CI tests and builds artifacts, PipeCD takes the rest +- Insights show metrics like lead time, deployment frequency, MTTR and change failure rate to measure delivery performance +- Designed to manage thousands of cross-platform applications in multi-cloud for company scale but also work well for small projects + +## PipeCD's Characteristics in detail + **Visibility** - Deployment pipeline UI shows clarify what is happening - Separate logs viewer for each individual deployment @@ -50,7 +61,9 @@ PipeCD provides a unified continuous delivery solution for multiple application ## Where should I go next? -For a good understanding of the PipeCD's components, see the [Concepts](../concepts) page. +For a good understanding of the PipeCD's components. +- [Concepts](../concepts): describes each components. +- [FAQ](../faq): describes the difference between PipeCD and other tools. If you are an **operator** wanting to install and configure PipeCD for other developers. - [Quickstart](../quickstart/)