Add Karmada x PipeCD guideline #680
Conversation
karmada-bot
added
the
kind/documentation
|
Welcome @khanhtc1202! It looks like this is your first PR to karmada-io/website 🎉 |
karmada-bot
added
the
size/L
|
Hi @khanhtc1202 You might need to update the side bars as well, otherwise, I can't get the preview. |
|
@RainbowMango Thanks for pointing out, I updated the PR 😄 |
| pipedID: <YOUR_PIPED_ID> | ||
| pipedKeyData: <YOUR_PIPED_KEY_DATA> |
There was a problem hiding this comment.
Do you want to explain how to set the YOUR_PIPED_ID and YOUR_PIPED_KEY_DATA a little bit?
There was a problem hiding this comment.
I referenced the quickstart docs for pipecd installation in the previous section already, so I think users are already know with it us up to this place. wdyt? 🤔
There was a problem hiding this comment.
Why not just update it to test as you give an example with that ID.
There was a problem hiding this comment.
Since that place requires not the piped name but the piped ID, which is different depending on users in the registered time, I think it could be less confusing if we keep it as is instead of mentioning the test piped name here. Users would also know that they need to find their <YOUR_PIPED_ID> and <YOUR_PIPED_KEY_DATA>, which could be found if they follow the quickstart docs.
There was a problem hiding this comment.
Also, if you still think it could be less confusing with the explanation, I can add something like
For <YOUR_PIPED_ID> and <YOUR_PIPED_KEY_DATA>, please refer to [installing piped](https://pipecd.dev/docs-v0.48.x/quickstart/#12-installing-piped) docs.WDYT? 🤔
There was a problem hiding this comment.
Addressed by 0fdbb78 🙏
|
OK. Last question, do you want to squash your commits? |
|
@RainbowMango Oh, I didn't notice that I usually use the merge and squash feature on GitHub UI. Let me try squash in my local 👍 |
karmada-bot
added
the
do-not-merge/contains-merge-commits
khanhtc1202
force-pushed
the
add-pipecd-colab-docs
branch
from
222e6f5
to
55aefe4
Compare
karmada-bot
removed
the
do-not-merge/contains-merge-commits
Signed-off-by: khanhtc1202 <[email protected]> Add link to sidebar Signed-off-by: khanhtc1202 <[email protected]> Add explanation about piped id and key Signed-off-by: khanhtc1202 <[email protected]>
khanhtc1202
force-pushed
the
add-pipecd-colab-docs
branch
from
55aefe4
to
487ad5a
Compare
|
@RainbowMango I squashed all commits, please check when you have time. Thank you 😄 |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: RainbowMango The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
karmada-bot
added
the
approved
What type of PR is this?
/kind documentation
What this PR does / why we need it:
This document explains how to use Karmada x PipeCD as a way to deploy the application's manifest resource to multi-cluster. Follow what we did at KubeCon HongKong 2024 (ref: https://sched.co/1eYYs)
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: