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

docs: add bypass feature user guide #108

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

DeshDeepakKant
Copy link
Contributor

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Adds user guide for the bypass feature introduced in Kmesh. The documentation covers configuration, usage, and troubleshooting of the bypass feature which allows users to temporarily remove mesh service from the traffic path.

Special notes for your reviewer:

  • Added configuration steps with examples
  • Included troubleshooting guidelines
  • Documented limitations and considerations
  • Part of Kmesh feature documentation

@kmesh-bot
Copy link
Collaborator

@DeshDeepakKant: The label(s) kind/documentation cannot be applied, because the repository doesn't have them.

In response to this:

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Adds user guide for the bypass feature introduced in Kmesh. The documentation covers configuration, usage, and troubleshooting of the bypass feature which allows users to temporarily remove mesh service from the traffic path.

Special notes for your reviewer:

  • Added configuration steps with examples
  • Included troubleshooting guidelines
  • Documented limitations and considerations
  • Part of Kmesh feature documentation

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@kmesh-bot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign hzxuzhonghu for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

@kmesh-bot
Copy link
Collaborator

Welcome @DeshDeepakKant! It looks like this is your first PR to kmesh-net/website 🎉

Copy link

netlify bot commented Jan 20, 2025

Deploy Preview for kmesh-net ready!

Name Link
🔨 Latest commit 20f4b84
🔍 Latest deploy log https://app.netlify.com/sites/kmesh-net/deploys/678f9e3f991c1f00081e45cf
😎 Deploy Preview https://deploy-preview-108--kmesh-net.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

- Add detailed documentation for bypass feature
- Include configuration examples
- Add troubleshooting steps
- Document limitations and considerations

Signed-off-by: DeshDeepakKant <[email protected]>
menu:
docs:
parent: user guide
weight: 19
Copy link
Contributor

Choose a reason for hiding this comment

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

This weight indicates the position of the page in the navigation bar. Try not to weight it the same as other pages

Before using the bypass feature, ensure you have:

- A running Kubernetes cluster
- Kmesh installed and configured
Copy link
Contributor

Choose a reason for hiding this comment

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

nit:You can give a link to kmesh quick start

@LiZhenCheng9527
Copy link
Contributor

Welcome! After this PR is merged, you can apply to join the Kmesh community.

Signed-off-by: DeshDeepakKant <[email protected]>
@DeshDeepakKant
Copy link
Contributor Author

DeshDeepakKant commented Jan 21, 2025

Welcome! After this PR is merged, you can apply to join the Kmesh community.

Thank you! I am already on Slack. Could you please let me know how I can apply to join the Kmesh community?

@LiZhenCheng9527
Copy link
Contributor

Thank you! I am already on Slack. Could you please let me know how I can apply to join the Kmesh community?

https://github.com/kmesh-net/community/blob/main/community-membership.md
This is what is expected of members in the Kmesh community.
This is an example: kmesh-net/kmesh#1186

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants