-
Notifications
You must be signed in to change notification settings - Fork 47
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
Enhancement README file #160
Conversation
cc @warjiang to take a look |
/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: |
There was a problem hiding this comment.
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 ?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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 🤣
There was a problem hiding this comment.
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]>
230b7c0
to
75615be
Compare
/lgtm |
[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 |
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?: