From f991e85aff5d057d5af6505a3f825a3f2224b777 Mon Sep 17 00:00:00 2001 From: Sivanantham <90966311+sivanantha321@users.noreply.github.com> Date: Sat, 27 Jul 2024 21:27:00 +0530 Subject: [PATCH] Add community information and fix broken links (#382) * Add community information Signed-off-by: Sivanantham Chinnaiyan * Fix broken links Signed-off-by: Sivanantham Chinnaiyan * Update docs/community/get_involved.md Co-authored-by: Dan Sun Signed-off-by: Sivanantham <90966311+sivanantha321@users.noreply.github.com> * Update docs/community/get_involved.md Co-authored-by: Dan Sun Signed-off-by: Sivanantham <90966311+sivanantha321@users.noreply.github.com> * Update docs/community/get_involved.md Co-authored-by: Dan Sun Signed-off-by: Sivanantham <90966311+sivanantha321@users.noreply.github.com> * Update docs/community/get_involved.md Co-authored-by: Dan Sun Signed-off-by: Sivanantham <90966311+sivanantha321@users.noreply.github.com> * Update docs/community/get_involved.md Co-authored-by: Dan Sun Signed-off-by: Sivanantham <90966311+sivanantha321@users.noreply.github.com> --------- Signed-off-by: Sivanantham Chinnaiyan Signed-off-by: Sivanantham <90966311+sivanantha321@users.noreply.github.com> Co-authored-by: Dan Sun --- docs/community/get_involved.md | 81 +++++++++++++++++++ docs/get_started/swagger_ui.md | 2 +- docs/help/contributor/github.md | 2 +- docs/modelserving/storage/oci.md | 6 +- .../modelserving/storage/storagecontainers.md | 2 +- docs/modelserving/v1beta1/lightgbm/README.md | 2 +- .../llm/huggingface/fill_mask/README.md | 4 +- .../text2text_generation/README.md | 2 +- .../huggingface/text_classification/README.md | 4 +- .../llm/huggingface/text_generation/README.md | 4 +- .../token_classification/README.md | 4 +- docs/modelserving/v1beta1/pmml/README.md | 2 +- .../torchserve_image_transformer/README.md | 2 +- mkdocs.yml | 1 + 14 files changed, 100 insertions(+), 18 deletions(-) create mode 100644 docs/community/get_involved.md diff --git a/docs/community/get_involved.md b/docs/community/get_involved.md new file mode 100644 index 000000000..440ee4ef0 --- /dev/null +++ b/docs/community/get_involved.md @@ -0,0 +1,81 @@ +# How to Get Involved + +Welcome to the KServe community! + + +Feel free to ask questions, engage in discussions, or get involved in the KServe's development. KServe, as an open-source project, thrives on the active participation of its community. Let's work together to make machine learning model serving effortless. Join us! + +## How do you want to get involved? + +### Ask Questions + +For the fastest response, you can ask questions on the `#kserve` channel of the [CNCF +Slack](https://slack.cncf.io/). +To Join the channel, [Create your CNCF Slack account](https://slack.cncf.io/) and Search for the `#kserve` channel or join via [this link](https://cloud-native.slack.com/archives/C06AH2C3K8B). + +If you prefer to use GitHub discussions, you can join the [KServe discussions](https://github.com/kserve/kserve/discussions). + +### Bug Reports and Feature Requests + +We use GitHub Issues to track bug reports and feature requests. Please file your issues and feature requests in the [KServe main repository](https://github.com/kserve/kserve/issues/new/choose). + +For Documentation related issues, please use the [KServe Website repository](https://github.com/kserve/website/issues/new/choose). + +For Open Inference Protocol (V2) related issues and feature requests, please use [Open Inference Protocol repository](https://github.com/kserve/open-inference-protocol/issues/new) + +A good bug report should include: + +- Description: Clearly state what you were trying to accomplish and what behavior you observed instead +- Versions: Specify the versions of relevant components + - KServe version + - Knative version (If using Serverless) + - Kubeflow version (If used with Kubeflow) + - Kubernetes version + - Cloud provider details (if using a cloud provider, indicate which one) +- Relevant resource yaml, HTTP requests, or log lines + +### Vulnerability Reports + +We strongly encourage you to report security vulnerabilities privately, before disclosing them in any public forums. Only the active maintainers and KServe security group members will receive the reported security vulnerabilities and the issues are treated as top priority. + +You can use the following ways to report security vulnerabilities privately: + +- Using our private security mailing list: [kserve-security@lists.lfaidata.foundation](mailto:kserve-security@lists.lfaidata.foundation). +- Using the [KServe repository GitHub Security Advisory](https://github.com/kserve/kserve/security/advisories/new) + +### Become a Contributor + +This is the place to start your journey as a contributor—whether it's enhancing code, improving documentation. KServe welcomes your contribution! + +If you're interested in becoming a KServe contributor, you'll want to check out +our [developer guide](../developer/developer.md). + + +### Communication Channels + +Much of the community meets on [the CNCF Slack](https://slack.cncf.io/), using the following channels: + +* [#kserve](https://cloud-native.slack.com/archives/C06AH2C3K8B): General discussion about KServe usage +* [#kserve-contributors](https://cloud-native.slack.com/archives/C06KZRPSDS7): General discussion channel for folks contributing to the KServe project in any capacity +* [#kserve-oip-collaboration](https://cloud-native.slack.com/archives/C06P4SYCNRX): Discussion area for Open Inference Protocol and API standardization + + +### Community Meetings + +We have public KServe WG biweekly community meetings on Wed 9AM US/Pacific and a public monthly Open Inference Protocol WG meeting on Wed 10AM US/Pacific. + +KServe WG Meeting agendas and notes can be accessed in the [working group document](https://docs.google.com/document/d/1KZUURwr9MnHXqHA08TFbfVbM8EAJSJjmaMhnvstvi-k). +Open Inference Protocol WG meeting minutes from the monthly work group sessions can be accessed in the [working group document](https://docs.google.com/document/d/1f21bja1ejHPrZRmY5ke0UxKVD26j0VntJxx0qGN3fKE). + + +You can access the meeting recordings on [the community calendar](https://zoom-lfx.platform.linuxfoundation.org/meetings/kserve?view=month) by clicking on the respective date's event details. + +Stay tuned for new events by subscribing to the +[community calendar](https://zoom-lfx.platform.linuxfoundation.org/meetings/kserve?view=month) ([iCal export file](https://webcal.prod.itx.linuxfoundation.org/lfx/a092M00001LkOceQAF)). + + + + + + + diff --git a/docs/get_started/swagger_ui.md b/docs/get_started/swagger_ui.md index d9fa18472..722259ffd 100644 --- a/docs/get_started/swagger_ui.md +++ b/docs/get_started/swagger_ui.md @@ -15,7 +15,7 @@ Swagger UI allows visualizing and interacting with the KServe InferenceService A Currently, `POST` request only work for `v2` endpoints in the UI. -To enable, simply add an extra argument to the InferenceService YAML example from [First Inference](../first_isvc) chapter: +To enable, simply add an extra argument to the InferenceService YAML example from [First Inference](first_isvc.md) chapter: ```bash hl_lines="9" kubectl apply -n kserve-test -f - <