mirror of
https://github.com/kubevela/kubevela.git
synced 2026-08-23 22:46:53 +00:00
Ayush Kumar
5b70fcc006
* Docs: overhaul CONTRIBUTING.md and issue templates Expand the root CONTRIBUTING.md from a one-line redirect into a real front door covering the Code of Conduct, ways to contribute, DCO sign-off, and links to governance and security. Convert the bug and feature issue templates from free-text Markdown into GitHub issue forms with required version fields and a duplicate-search checkbox, merging the separate enhancement template into the feature form. Fix stale oam-dev/kubevela references in bot.md, issue-commands.json, and ISSUE_TRIAGE.md, add a Security contact link and disable blank issues in the issue template config, and add a DCO checklist item to the pull request template. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: expand GOVERNANCE.md and community.md stubs GOVERNANCE.md and community.md were one and two line redirects to the community repo. Both now cover Code of Conduct, meetings, KEP process, membership ladder, security, and releases (GOVERNANCE.md) or communication channels, how to get involved, and governance links (community.md), as short maps that link out to the community repo for anything that changes often, rather than duplicating it. CONTRIBUTING.md's Communication line now points at the local community.md first. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: rename community.md to COMMUNITY.md Match the all-caps naming used by CONTRIBUTING.md, GOVERNANCE.md, CODE_OF_CONDUCT.md, and SECURITY.md. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: fix stale domains in README and de-duplicate ISSUE_TRIAGE.md README.md had three kubevela.net links left over from the domain move to kubevela.io, and a Contact Us / Community Call section that duplicated, and disagreed with on cadence, what COMMUNITY.md now documents. Point Community, Contributing, and Report Vulnerability at the local COMMUNITY.md, CONTRIBUTING.md, and SECURITY.md instead of re-describing them inline. ISSUE_TRIAGE.md was a full copy of the community repo's canonical document. That's how it went stale in the first place, still referencing oam-dev/kubevela after the org move. Replaced it with a short pointer to the canonical copy, matching how GOVERNANCE.md and COMMUNITY.md already work. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: bring contribute/ folder up to the same standard These six files were the original bare-stub redirects this whole pass started from. Their links were already correct, unlike everything else touched in this branch, but they were the last remaining one-line 'please refer to X' pages in the repo. Each now has a short line of real context before the link, and README.md cross-links the new CONTRIBUTING.md front door instead of only pointing out to kubevela.io. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: remove contribute/ folder, fold it into CONTRIBUTING.md The contribute/ folder was six tiny files that each pointed at one kubevela.io page, and every one of those pages was already linked from CONTRIBUTING.md's Ways to contribute and More sections. Keeping both meant two indexes into the same handful of pages, organized differently, with no content of its own beyond the links. Folded the two links CONTRIBUTING.md was missing, code conventions and test principles, into the Code bullet, and removed the folder. The develop-code-flow.pdf diagram wasn't linked from anywhere in the repo and duplicates what release-process.md already covers, so it goes too. PULL_REQUEST_TEMPLATE.md's contribution process checklist item pointed at contribute/create-pull-request.md; repointed it at CONTRIBUTING.md. Confirmed with a repo-wide grep that nothing else referenced the contribute/ path. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: fix dangling references flagged by review Three real issues from automated review, still present at HEAD: GOVERNANCE.md's membership sentence read as four roles after three levels beyond contributor instead of three, missing a colon. README.md claimed the meeting schedule lives in COMMUNITY.md, which explicitly says it doesn't. ISSUE_TRIAGE.md attributed the type/area/priority label taxonomy to COMMUNITY.md, which never describes those labels, repointed to the canonical ISSUE_TRIAGE.md already linked at the top of the same file. Two other flagged issues (CONTRIBUTING.md's issue-triage and governance links) were valid against an earlier commit but got resolved in the opposite direction by later commits in this branch, converting ISSUE_TRIAGE.md and GOVERNANCE.md into pointers/maps rather than repointing links at them. The type/feature label flag is accurate but intentional, a maintainer is creating that label. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: split feature and enhancement issue forms back apart The merged feature_request.yml applied type/feature regardless of which option the kind dropdown picked, silently dropping the type/enhancement distinction the old enhancement_request.md preserved and that ISSUE_TRIAGE.md and issue-commands.json still reference. GitHub issue forms can't conditionally set a label based on a form answer, so the only way to keep both labels working is two templates again: feature_request.yml (type/feature, for net-new capability) and enhancement_request.yml (type/enhancement, for improving something that exists), each asking only the questions relevant to that case. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: link PR template directly to the pull request process CONTRIBUTING.md is a front door, not the PR process itself, it links out to code-contribute.md for that. Pointing the PR template's checklist item straight at the section with the actual process (title format, DCO, backport labels) saves the contributor an extra hop at the exact moment they're creating a PR, matching how Kubernetes and Crossplane link their PR templates directly to the dev guide. Verified the anchor resolves on the live page before pushing. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: add a Quick start section to CONTRIBUTING.md Compared to peer CNCF projects (Kubernetes, Crossplane, etcd, Helm), CONTRIBUTING.md had zero runnable commands, a contributor had to click through to kubevela.io just to learn how to build or test locally. Added the three commands that matter most (make, make test, make reviewable, all verified against the actual Makefile targets) so the basics don't require leaving the repo. Left the fuller dev environment setup, coding style rules, and PR lifecycle narrative as link-outs rather than duplicating them here, that content is detailed enough (Go/kustomize/CUE/kubebuilder versions, VelaUX, e2e setup) that inlining it would just recreate the drift problem ISSUE_TRIAGE.md had before this PR. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: document commit message format in CONTRIBUTING.md etcd, Kubernetes, and Helm all state their commit message convention directly in CONTRIBUTING.md. KubeVela has one too (Type: subject, documented in full at code-contribute.md#formatting-guidelines) but it was never mentioned here. Added the format and three real examples inline, kept the full scope/area rules and PR title/squash policy as a link-out rather than duplicating all of it. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: drop unrelated tagline from bot comments issue-commands.json's bot/duplicate and bot/no new info comments both ended with 'Happy graphing!', a leftover from some other project's bot config with nothing to do with KubeVela. Already editing this file for the org-name fixes, so dropped the tagline from both, and fixed a duplicated 'you you' typo in the second one while there. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: break up long Ways to contribute bullets The Code bullet ran past 400 characters on one line. Split Code, Docs, Issue triage, and Everything else into a lead-in plus sub-bullets, matching Crossplane's CONTRIBUTING style, left Answer questions as a single line since it was already short enough to scan. No content changed, just line length. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: add existing-issue-search checkbox to feature and enhancement forms bug_report.yml has a required checkbox confirming the reporter searched for duplicates first; feature_request.yml and enhancement_request.yml didn't, despite Kubernetes applying this consistently across all its issue forms. Added the same required checkbox to both, worded for a feature/enhancement rather than a bug. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Docs: fix comma splice in COMMUNITY.md Split one sentence into two instead of joining them with a comma. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> * Chore: add roguepikachu to comment.userlist Grants triage bot comment command access per bot.md. Signed-off-by: Ayush Kumar <ayushshyamkumar888@gmail.com> Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com> --------- Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>
Make shipping applications more enjoyable.
Introduction
KubeVela is a modern application delivery platform that makes deploying and operating applications across today's hybrid, multi-cloud environments easier, faster and more reliable.
Highlights
KubeVela practices the "render, orchestrate, deploy" workflow with below highlighted values added to existing ecosystem:
Deployment as Code
Declare your deployment plan as workflow, run it automatically with any CI/CD or GitOps system, extend or re-program the workflow steps with CUE. No ad-hoc scripts, no dirty glue code, just deploy. The deployment workflow in KubeVela is powered by Open Application Model.
Built-in observability, multi-tenancy and security support
Choose from the wide range of LDAP integrations we provided out-of-box, enjoy enhanced multi-tenancy and multi-cluster authorization and authentication, pick and apply fine-grained RBAC modules and customize them as per your own supply chain requirements. All delivery process has fully automated observability dashboards.
Multi-cloud/hybrid-environments app delivery as first-class citizen
Natively supports multi-cluster/hybrid-cloud scenarios such as progressive rollout across test/staging/production environments, automatic canary, blue-green and continuous verification, rich placement strategy across clusters and clouds, along with automated cloud environments provision.
Lightweight but highly extensible architecture
Minimize your control plane deployment with only one pod and 0.5c1g resources to handle thousands of application delivery. Glue and orchestrate all your infrastructure capabilities as reusable modules with a highly extensible architecture and share the large growing community addons.
Getting Started
Get Your Own Demo with Alibaba Cloud
-
install KubeVela on a Serverless K8S cluster in 3 minutes, try:
Documentation
Full documentation is available on the KubeVela website.
Blog
Official blog is available on KubeVela blog.
Community
We want your contributions and suggestions! One of the easiest ways to contribute is to participate in discussions on the Github Issues/Discussion, chat on IM or the community calls. See COMMUNITY.md for Slack, DingTalk, WeChat, and meeting info, and the KubeVela community repo for joining links, the current meeting schedule, and developer and contributing guidelines.
Talks and Conferences
Check out KubeVela videos for these talks and conferences.
Contributing
Check out CONTRIBUTING.md to see how to develop with KubeVela.
Report Vulnerability
Security is a first priority thing for us at KubeVela. See SECURITY.md to report an issue privately, or send email directly to security@mail.kubevela.io.
Code of Conduct
KubeVela adopts CNCF Code of Conduct.