docs(defkit): expand definition-builder method tables to match API reference#1428
Draft
jerrinfrancis wants to merge 12 commits intokubevela:mainfrom
Draft
docs(defkit): expand definition-builder method tables to match API reference#1428jerrinfrancis wants to merge 12 commits intokubevela:mainfrom
jerrinfrancis wants to merge 12 commits intokubevela:mainfrom
Conversation
…ity (first pass of revamp) Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>
…pages (second pass of revamp) Add comprehensive API parameter tables from defkit-reference.html to all markdown documentation pages that were missing them. Tables cover ~350 methods across parameters, templates, resources, expressions, collections, helpers, patches, health/status, context, placement, workflow ops, validators, and testing. Changes applied to both docs/ and versioned_docs/ version-v1.11-alpha/ to keep them in sync. Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>
…d CUE prerequisite Port kubevela#1426 to versioned_docs/v1.11-alpha: bump Go to 1.23.8, move generated CUE example after the gen-module step, and update it to match current generator output. Add CUE v0.14.1+ as a prerequisite in both docs/ and versioned_docs/ Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>
Signed-off-by: Vaibhav Agrawal <vaibhav.agrawal0096@gmail.com>
…parison table with decision boxes Collapse Benefits subheadings into a bullet list. Replace the Go-vs-CUE comparison table with tip/note admonition boxes that focus on the decision rather than restating advantages. Remove the redundant info block. Signed-off-by: Vaibhav Agrawal <vaibhav.agrawal0096@gmail.com>
Use <details> elements to make all code blocks in quick-start.md collapsible, keeping the page scannable while preserving full examples for users who expand them. Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>
…t path Wrap module structure and code examples in <details> elements. Replace placeholder import github.com/.../defkit with the full package path github.com/oam-dev/kubevela/pkg/definition/defkit. Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>
…ical), remove duplication Refactor architecture.md to focus on the end-to-end pipeline, the Definition interface contract, and health evaluation — no code blocks. Refactor integration.md to own all practical setup: go.mod, module structure, registration pattern, CLI commands. Add registry query functions table, ToJSON() output schema, and Register() placement validation warning. Update Go to 1.23.8 and KubeVela to v1.11.0. Make all code blocks collapsible Signed-off-by: Jerrin Francis <jerrinfrancis7@gmail.com>
…n Builder Signed-off-by: Anaswara Suresh M K <anaswarasuresh22122gmail.com>
Signed-off-by: Anaswara Suresh M K <anaswarasuresh22122gmail.com>
Signed-off-by: Anaswara Suresh M K <anaswarasuresh22122gmail.com>
bc34415 to
f744578
Compare
f744578 to
fdfe0de
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of your changes
Brings the four defkit definition-builder doc pages up to parity with the consolidated
defkit-reference.htmlsingle-page reference, so the method tables users see in the docs list every public builder method instead of a curated subset.docs/platform-engineers/defkit/definition-component.md— 14 → 27 methods, grouped under Metadata / Workload / Parameters & Template / Health & Status / Placement / Escape Hatches / Output.docs/platform-engineers/defkit/definition-trait.md— 10 → 27 methods, split into Trait-specific (9) and Shared base (18) sections.docs/platform-engineers/defkit/definition-policy.md— 3 → 19 methods, split into Policy-specific (2) and Shared base (17); documentsPolicyTemplate.Set.docs/platform-engineers/defkit/definition-workflowstep.md— 6 → 22 methods, split into step-specific (5) and shared (17); addsWorkflowStepTemplate(6) andBuiltinActionBuilder(5) sub-builder tables.versioned_docs/version-v1.11-alpha/platform-engineers/defkit/.Follow-up to #1421 and #1425. Method names/signatures verified against
pkg/definition/defkit/{component,trait,policy,workflow_step}.goinkubevela/kubevela.I have:
sidebar.jsif adding a new page. (No new pages.)yarn startto ensure the changes has taken effect.Special notes for your reviewer
First pass of a larger revamp — follow-ups will extend table parity to the parameter / template / helper / collection / patch / validator pages. Opening as draft accordingly. Descriptions lifted from the in-repo
defkit-reference.html, lightly trimmed.Summary by cubic
Expands
defkitdocs to full API parity with the single-pagedefkit-reference.html, and refactors docs structure (architecture vs integration) while refreshing Quick Start. Adds concise method tables across builders and supporting pages, updates examples, and syncs all changes toversioned_docs/version-v1.11-alpha/.New Features
WorkflowStepTemplateandBuiltinActionBuildersub-builders; improved examples.velactx, cluster placement (label conditions + combinators), health/status DSL presets, for-each variants, workflow op builders; ships consolidateddefkit-reference.html.Refactors
go.modwithgithub.com/oam-dev/kubevela v1.11.0, module layout, registration, registry query functions,ToJSON()schema,Register()placement validation note); fixes import path togithub.com/oam-dev/kubevela/pkg/definition/defkit.definition-registerto the Defkit nav and mirrors the change in the versioned sidebar.Written for commit fdfe0de. Summary will update on new commits.