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

Enhancement README file #160

Merged
merged 1 commit into from
Jan 14, 2025

Conversation

RainbowMango
Copy link
Member

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This PR adds more details instructions on the quick start part.

In addition, I removed the cn README, since there are still some enhancements ongoing, not necessary to maintain two versions at current maturity.

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jan 10, 2025
@karmada-bot karmada-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 10, 2025
@RainbowMango
Copy link
Member Author

cc @warjiang to take a look

@warjiang
Copy link
Contributor

/assign

Note that, the Karmada Dashboard service type is `NodePort`, this exposes the dashboard on a specific port on each node
of your `host cluster`, allowing you to access it via any node's IP address and that port.

You also can use `kubectl port-forward` to forward a local port to the Dashboard's backend pod:
Copy link
Contributor

Choose a reason for hiding this comment

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

One way for user to access Karmada Dashboad is nodePort for karmada-dashboard-web service. Another way is port-foward, maybe use port-forward for karmada-dashboard-web service will be better than port-forward for pod ?

Copy link
Contributor

Choose a reason for hiding this comment

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

@RainbowMango maybe port-forward karmada-dashboard-web instead of karmada-dashboard-web pod be better
image

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, updated as recommended.

README.md Outdated
cd dashboard
```

Create the secret based on your Karmada config, the Karmada Dashboard will use this config talk to Karmada API server.
Copy link
Contributor

Choose a reason for hiding this comment

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

will use this config to talk to

Copy link
Contributor

Choose a reason for hiding this comment

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

@RainbowMango update the grammer error 🤣

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated as recommended. Thanks.

Signed-off-by: RainbowMango <[email protected]>
@RainbowMango RainbowMango force-pushed the pr_optimize_quickstart branch from 230b7c0 to 75615be Compare January 13, 2025 02:47
@warjiang
Copy link
Contributor

/lgtm
/approve

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: warjiang

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 14, 2025
@karmada-bot karmada-bot merged commit 46b8a29 into karmada-io:main Jan 14, 2025
6 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. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants