-
Notifications
You must be signed in to change notification settings - Fork 104
docs: professionalize site messaging and add project governance #480
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
base: master
Are you sure you want to change the base?
docs: professionalize site messaging and add project governance #480
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome @yoursanonymous! It looks like this is your first PR to volcano-sh/website 🎉 |
Summary of ChangesHello @yoursanonymous, 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 significantly enhances the Volcano project's website by professionalizing its public-facing content and establishing crucial governance documentation. The changes aim to improve the project's branding, replace development placeholders with official information, and integrate essential guides for contributors and security vulnerability reporting, thereby ensuring the project meets CNCF standards for open-source projects. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
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.
Code Review
This pull request significantly improves the project's website by adding key governance documents (CONTRIBUTING.md, SECURITY.md), updating site configuration to use real project information instead of placeholders, and refining the project's messaging. The changes are well-done and professional. I have one suggestion to further improve the new security policy for long-term clarity.
| | Version | Supported | | ||
| | ------- | ------------------ | | ||
| | v1.11.x | :white_check_mark: | | ||
| | v1.10.x | :white_check_mark: | | ||
| | < v1.10 | :x: | |
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.
The table of supported versions is a great start. To avoid it becoming outdated and to provide clarity for future releases, consider stating the project's version support policy explicitly. For example, you could mention how many recent minor versions are supported (e.g., 'The two most recent minor versions receive security updates.'). This would make the policy clearer for users and contributors as new versions of Volcano are released.
…(SECURITY/CONTRIBUTING) Signed-off-by: vinayak sharma <vinayaks0111@gmail.com>
797941c to
d3fd873
Compare
/kind documentation
This PR enhances the Volcano website by improving core project branding, removing development placeholders, and establishing essential project governance documentation to ensure the project meets CNCF standards.
issue #481