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 docs for overview #4655

Merged
merged 2 commits into from
Nov 6, 2023
Merged

Update docs for overview #4655

merged 2 commits into from
Nov 6, 2023

Conversation

ffjlabo
Copy link
Member

@ffjlabo ffjlabo commented Nov 6, 2023

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #

Does this PR introduce a user-facing change?:

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

Signed-off-by: Yoshiki Fujikane <[email protected]>
- 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

## Characteristics in detail
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Characteristics in detail
## PipeCD's characteristics in detail

Copy link

codecov bot commented Nov 6, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8c202c7) 30.00% compared to head (4b2f84d) 30.81%.
Report is 22 commits behind head on master.

❗ Current head 4b2f84d differs from pull request most recent head f99ddf4. Consider uploading reports for the commit f99ddf4 to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4655      +/-   ##
==========================================
+ Coverage   30.00%   30.81%   +0.81%     
==========================================
  Files         221      221              
  Lines       25955    25941      -14     
==========================================
+ Hits         7787     7995     +208     
+ Misses      17519    17295     -224     
- Partials      649      651       +2     

see 13 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@@ -49,3 +49,12 @@ 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 k8s?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### 7. What is the strong point if PipeCD is used only for k8s?
### 7. What is the strong point if PipeCD is used only for Kubernetes?

Comment on lines 55 to 56
- easy to install and upgrade the tools, you just choose desired version on WebUI
-
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- easy to install and upgrade the tools, you just choose desired version on WebUI
-
- 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

Signed-off-by: Yoshiki Fujikane <[email protected]>
@ffjlabo ffjlabo changed the title update overview Update docs for overview Nov 6, 2023
Copy link
Member

@khanhtc1202 khanhtc1202 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧨

@ffjlabo ffjlabo merged commit 8b0a501 into master Nov 6, 2023
12 checks passed
@ffjlabo ffjlabo deleted the update-overview branch November 6, 2023 07:13
@github-actions github-actions bot mentioned this pull request Dec 1, 2023
sZma5a pushed a commit to sZma5a/pipecd that referenced this pull request Dec 17, 2023
* update overview

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Fix docs

Signed-off-by: Yoshiki Fujikane <[email protected]>

---------

Signed-off-by: Yoshiki Fujikane <[email protected]>
sZma5a pushed a commit to sZma5a/pipecd that referenced this pull request Dec 17, 2023
* update overview

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Fix docs

Signed-off-by: Yoshiki Fujikane <[email protected]>

---------

Signed-off-by: Yoshiki Fujikane <[email protected]>
@github-actions github-actions bot mentioned this pull request Feb 6, 2024
sZma5a pushed a commit to sZma5a/pipecd that referenced this pull request Feb 12, 2024
* update overview

Signed-off-by: Yoshiki Fujikane <[email protected]>

* Fix docs

Signed-off-by: Yoshiki Fujikane <[email protected]>

---------

Signed-off-by: Yoshiki Fujikane <[email protected]>
Signed-off-by: 鈴木 優耀 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants