[doc] add contact us in community #19922
Conversation
Signed-off-by: reidliu41 <reid201711@gmail.com>
|
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @reidliu41, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a new documentation page to provide a clear and centralized resource for users and collaborators to find various ways to contact the project, aiming for consistency with information presented on the GitHub homepage.
Highlights
- New Documentation Page: A new Markdown file,
contact_us.md, has been added to thedocs/community/directory. - Comprehensive Contact Information: The newly added page centralizes various contact channels, including GitHub Issues/Discussions for technical questions, vLLM Forum for user discussions, Slack for development coordination, GitHub Security Advisories for disclosures, and a dedicated email address for collaborations and partnerships.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request adds a new 'Contact Us' page to the community section of the documentation, centralizing information on how to get in touch with the project maintainers and community. The content is based on the information from the project's GitHub homepage. I focused on improving the correctness of the links and the maintainability of the new markdown file.
| - For technical questions and feature requests, please use GitHub [Issues](https://github.com/vllm-project/vllm/issues) or [Discussions](https://github.com/vllm-project/vllm/discussions) | ||
| - For discussing with fellow users, please use the [vLLM Forum](https://discuss.vllm.ai) | ||
| - For coordinating contributions and development, please use [Slack](https://slack.vllm.ai) | ||
| - For security disclosures, please use GitHub's [Security Advisories](https://github.com/vllm-project/vllm/security/advisories) feature |
There was a problem hiding this comment.
The link for security disclosures points to the list of existing advisories. For reporting a new vulnerability, it would be more helpful to link directly to the submission form.
| - For security disclosures, please use GitHub's [Security Advisories](https://github.com/vllm-project/vllm/security/advisories) feature | |
| - For security disclosures, please use GitHub's [Security Advisories](https://github.com/vllm-project/vllm/security/advisories/new) feature |
| --- | ||
| title: Contact Us | ||
| --- | ||
| [](){ #contactus } |
There was a problem hiding this comment.
This line uses a non-standard and obscure markdown syntax ([](){ #contactus }) to create an anchor. This can be confusing for future contributors. If this anchor is not used for deep-linking from other pages, it's best to remove it for simplicity.
Signed-off-by: reidliu41 <reid201711@gmail.com>
|
Thanks! |
github-actions
bot
added
the
ready
|
Instead of manual syncing would it not be better to use snippets? https://facelessuser.github.io/pymdown-extensions/extensions/snippets/ |
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
|
thanks for remind #19944 |
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com> Signed-off-by: juncheoll <th6re8e@naver.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com> Signed-off-by: fhl <2410591650@qq.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com> Signed-off-by: Will Eaton <weaton@redhat.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com> Signed-off-by: avigny <47987522+avigny@users.noreply.github.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Co-authored-by: reidliu41 <reid201711@gmail.com>
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.Purpose
contact usand keep the same with thegithub home pageTest Plan
Test Result
(Optional) Documentation Update