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

doc: add user guide and tutorial doc of mcs #548

Merged
merged 1 commit into from
Jan 9, 2024

Conversation

jwcesign
Copy link
Member

@jwcesign jwcesign commented Jan 8, 2024

What type of PR is this?
/kind documentation

What this PR does / why we need it:
doc: add user guide and tutorial doc of mcs

Which issue(s) this PR fixes:
Fixes #none

Special notes for your reviewer:
none

@karmada-bot karmada-bot requested review from Arhell and Tingtal January 8, 2024 09:46
@karmada-bot karmada-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 8, 2024
@jwcesign jwcesign marked this pull request as draft January 8, 2024 09:49
@karmada-bot karmada-bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 8, 2024
@jwcesign jwcesign force-pushed the main branch 2 times, most recently from 1b7af22 to aaaedec Compare January 8, 2024 12:41
@karmada-bot karmada-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jan 8, 2024
@jwcesign jwcesign marked this pull request as ready for review January 8, 2024 12:42
@karmada-bot karmada-bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 8, 2024
@jwcesign jwcesign changed the title doc: add mcs doc doc: add user guide and tutorial doc of mcs Jan 8, 2024
@jwcesign jwcesign force-pushed the main branch 2 times, most recently from 053da37 to 7636967 Compare January 8, 2024 12:54
@jwcesign
Copy link
Member Author

jwcesign commented Jan 8, 2024

@XiShanYongYe-Chang
Copy link
Member

/assign

@jwcesign jwcesign force-pushed the main branch 2 times, most recently from 4021cb0 to f4cf6e5 Compare January 9, 2024 02:21
@jwcesign
Copy link
Member Author

jwcesign commented Jan 9, 2024

/cc @XiShanYongYe-Chang
Please take another look

Copy link
Member

@XiShanYongYe-Chang XiShanYongYe-Chang left a comment

Choose a reason for hiding this comment

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

/lgtm

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Jan 9, 2024
@jwcesign
Copy link
Member Author

jwcesign commented Jan 9, 2024

/cc @RainbowMango
for checking

Copy link
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

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

Nice work! Just some typos found.

Signed-off-by: jwcesign <[email protected]>
@karmada-bot karmada-bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 9, 2024

### Karmada has been installed

We can install Karmada by referring to [Quick Start](https://github.com/karmada-io/karmada#quick-start), or directly run `hack/local-up-karmada.sh` script which is also used to run our E2E cases.
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it necessary to inform users about hack/local-up-karmada.sh is used for e2e cases?

Copy link
Member Author

Choose a reason for hiding this comment

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

@@ -0,0 +1,108 @@
<mxfile host="Electron" modified="2024-01-09T11:15:29.317Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.6.8 Chrome/114.0.5735.289 Electron/25.5.0 Safari/537.36" etag="ZryrKlNv4eWpEWFRcYkw" version="21.6.8" type="device">
Copy link
Contributor

Choose a reason for hiding this comment

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

Are these codes the source code of your images? looks good~

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, it's the source file of draw.io

@jwcesign
Copy link
Member Author

jwcesign commented Jan 9, 2024

/cc @RainbowMango

Copy link
Member

@RainbowMango RainbowMango left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@karmada-bot karmada-bot added the lgtm Indicates that a PR is ready to be merged. label Jan 9, 2024
@karmada-bot
Copy link
Collaborator

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@karmada-bot karmada-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 9, 2024
@karmada-bot karmada-bot merged commit b208a53 into karmada-io:main Jan 9, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants