Skip to content

Commit

Permalink
docs: add 0.10 sidebar and docs
Browse files Browse the repository at this point in the history
Signed-off-by: peefy <[email protected]>
  • Loading branch information
Peefy committed Aug 14, 2024
1 parent 52b4df2 commit 307d24e
Show file tree
Hide file tree
Showing 370 changed files with 64,701 additions and 152 deletions.
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.9
0.10
4 changes: 2 additions & 2 deletions blog/2024-07-22-jsonnet-kcl-comparison/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ local a(name) = {

Run time (considering actual resource expenditure in production environments, this test is based on a single core):

| KCL v0.9.3 | Jsonnet v0.20.0 (C++ version) | Jsonnet v0.20.0 (Go version) | Jsonnet v0.5.0-pre96 (Rust version jrsonnet) | Jsonnet v0.1.2 (Rust version rsjsonnet) |
| ------------------- | ----------------------------- | ------------------------------ | -------------------------------------------- | --------------------------------------- |
| KCL v0.9.3 | Jsonnet v0.20.0 (C++ version) | Jsonnet v0.20.0 (Go version) | Jsonnet v0.5.0-pre96 (Rust version jrsonnet) | Jsonnet v0.1.2 (Rust version rsjsonnet) |
| ------------------- | ------------------------------ | ----------------------------- | -------------------------------------------- | --------------------------------------- |
| 155 ms (kcl test.k) | 1480 ms (jsonnet test.jsonnet) | 400 ms (jsonnet test.jsonnet) | 153 ms (rsjsonnet test.jsonnet) | 142 ms (jrsonnet test.jsonnet) |

## Summary
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/xlang-api/kotlin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ Kotlin Code
import com.kcl.api.API
import com.kcl.api.validateCodeArgs

val args = validateCodeArgs {
val args = validateCodeArgs {
code = "schema Person:\n" + " name: str\n" + " age: int\n" + " check:\n" + " 0 < age < 120\n"
data = "{\"name\": \"Alice\", \"age\": 10}"
}
Expand Down
5 changes: 2 additions & 3 deletions examples/kubernetes/from-kubernetes/kcl.mod
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[package]
name = "from-kubernetes"
edition = "v0.9.0"
edition = "v0.10.0"
version = "0.0.1"

[dependencies]
crd = { path = "./models" }

crd = { path = "./models" }
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Editing this file might prove futile when you re-run the KCL auto-gen generate c


schema ManagedFieldsEntry:
"""
r"""
ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Editing this file might prove futile when you re-run the KCL auto-gen generate c


schema ObjectMeta:
"""
r"""
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Editing this file might prove futile when you re-run the KCL auto-gen generate c


schema OwnerReference:
"""
r"""
OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Attributes
Expand Down
4 changes: 1 addition & 3 deletions examples/kubernetes/from-kubernetes/models/kcl.mod
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
[package]
name = "models"
edition = "v0.9.0"
edition = "v0.10.0"
version = "0.0.1"


Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import k8s.apimachinery.pkg.apis.meta.v1


schema CronTab:
"""
r"""
stable example com v1 cron tab

Attributes
Expand All @@ -32,7 +32,7 @@ schema CronTab:


schema StableExampleComV1CronTabSpec:
"""
r"""
stable example com v1 cron tab spec

Attributes
Expand Down
3 changes: 1 addition & 2 deletions examples/package-management/git/my_package/kcl.mod.lock
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[dependencies]
[dependencies.konfig]
name = "konfig"
full_name = "konfig_v0.0.1"
version = "v0.0.1"
full_name = "_"
sum = "XFvHdBAoY/+qpJWmj8cjwOwZO8a3nX/7SE35cTxQOFU="
url = "https://github.com/awesome-kusion/konfig.git"
git_tag = "v0.0.1"
5 changes: 5 additions & 0 deletions examples/package-management/oci/my_package/kcl.mod.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
[dependencies]
[dependencies.k8s]
name = "k8s"
full_name = "k8s_1.28"
version = "1.28"
250 changes: 250 additions & 0 deletions i18n/en/docusaurus-plugin-content-docs/version-0.10.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,250 @@
{
"version.label": {
"message": "0.10",
"description": "The label for version 0.10"
},
"sidebar.docs.category.Tools": {
"message": "Tools",
"description": "The label for category Tools in sidebar docs"
},
"sidebar.docs.category.Command Line Tools": {
"message": "Command Line Tools",
"description": "The label for category Command Line Tools in sidebar docs"
},
"sidebar.docs.category.KCL Tools": {
"message": "KCL Tools",
"description": "The label for category KCL Tools in sidebar docs"
},
"sidebar.docs.category.Package Management Tools": {
"message": "Package Management Tools",
"description": "The label for category Package Management Tools in sidebar docs"
},
"sidebar.docs.category.Command Reference": {
"message": "Command Reference",
"description": "The label for category Command Reference in sidebar docs"
},
"sidebar.docs.category.OpenAPI Tools": {
"message": "OpenAPI Tools",
"description": "The label for category OpenAPI Tools in sidebar docs"
},
"sidebar.docs.category.IDE": {
"message": "IDE",
"description": "The label for category IDE in sidebar docs"
},
"sidebar.docs.category.Reference": {
"message": "Reference",
"description": "The label for category Reference in sidebar docs"
},
"sidebar.docs.category.Tutorial": {
"message": "Tutorial",
"description": "The label for category Tutorial in sidebar docs"
},
"sidebar.docs.category.Code Lab": {
"message": "Code Lab",
"description": "The label for category Code Lab in sidebar docs"
},
"sidebar.docs.category.Spec": {
"message": "Spec",
"description": "The label for category Spec in sidebar docs"
},
"sidebar.docs.category.Errors and Warnings": {
"message": "Errors and Warnings",
"description": "The label for category Errors and Warnings in sidebar docs"
},
"sidebar.docs.category.System Package": {
"message": "System Package",
"description": "The label for category System Package in sidebar docs"
},
"sidebar.docs.category.Multi-Language": {
"message": "Multi-Language",
"description": "The label for category Multi-Language in sidebar docs"
},
"sidebar.docs.category.Plugin System": {
"message": "Plugin System",
"description": "The label for category Plugin System in sidebar docs"
},
"sidebar.docs.category.community": {
"message": "community",
"description": "The label for category community in sidebar docs"
},
"sidebar.docs.category.Community": {
"message": "Community",
"description": "The label for category Community in sidebar docs"
},
"sidebar.docs.category.Release Policy": {
"message": "Release Policy",
"description": "The label for category Release Policy in sidebar docs"
},
"sidebar.docs.category.Contribution Guide": {
"message": "Contribution Guide",
"description": "The label for category Contribution Guide in sidebar docs"
},
"sidebar.docs.category.user_docs": {
"message": "user_docs",
"description": "The label for category user_docs in sidebar docs"
},
"sidebar.docs.category.Getting Started": {
"message": "Getting Started",
"description": "The label for category Getting Started in sidebar docs"
},
"sidebar.docs.category.Guides": {
"message": "Guides",
"description": "The label for category Guides in sidebar docs"
},
"sidebar.docs.category.How to": {
"message": "How to",
"description": "The label for category How to in sidebar docs"
},
"sidebar.docs.category.Kubernetes": {
"message": "Kubernetes",
"description": "The label for category Kubernetes in sidebar docs"
},
"sidebar.docs.category.Mutate or Validate Kubernetes Manifests": {
"message": "Mutate or Validate Kubernetes Manifests",
"description": "The label for category Mutate or Validate Kubernetes Manifests in sidebar docs"
},
"sidebar.docs.category.Konfig": {
"message": "Konfig",
"description": "The label for category Konfig in sidebar docs"
},
"sidebar.docs.category.GitOps": {
"message": "GitOps",
"description": "The label for category GitOps in sidebar docs"
},
"sidebar.docs.category.CI Integration": {
"message": "CI Integration",
"description": "The label for category CI Integration in sidebar docs"
},
"sidebar.docs.category.Secret Management": {
"message": "Secret Management",
"description": "The label for category Secret Management in sidebar docs"
},
"sidebar.docs.category.Terraform": {
"message": "Terraform",
"description": "The label for category Terraform in sidebar docs"
},
"sidebar.docs.category.Concepts": {
"message": "Concepts",
"description": "The label for category Concepts in sidebar docs"
},
"sidebar.docs.category.FAQ": {
"message": "FAQ",
"description": "The label for category FAQ in sidebar docs"
},
"sidebar.user_docs.category.Getting Started": {
"message": "Getting Started",
"description": "The label for category Getting Started in sidebar user_docs"
},
"sidebar.user_docs.category.Guides": {
"message": "Guides",
"description": "The label for category Guides in sidebar user_docs"
},
"sidebar.user_docs.category.Package Management Tools": {
"message": "Package Management Tools",
"description": "The label for category Package Management Tools in sidebar user_docs"
},
"sidebar.user_docs.category.How to": {
"message": "How to",
"description": "The label for category How to in sidebar user_docs"
},
"sidebar.user_docs.category.Kubernetes": {
"message": "Kubernetes",
"description": "The label for category Kubernetes in sidebar user_docs"
},
"sidebar.user_docs.category.Mutate or Validate Kubernetes Manifests": {
"message": "Mutate or Validate Kubernetes Manifests",
"description": "The label for category Mutate or Validate Kubernetes Manifests in sidebar user_docs"
},
"sidebar.user_docs.category.Konfig": {
"message": "Konfig",
"description": "The label for category Konfig in sidebar user_docs"
},
"sidebar.user_docs.category.GitOps": {
"message": "GitOps",
"description": "The label for category GitOps in sidebar user_docs"
},
"sidebar.user_docs.category.CI Integration": {
"message": "CI Integration",
"description": "The label for category CI Integration in sidebar user_docs"
},
"sidebar.user_docs.category.Secret Management": {
"message": "Secret Management",
"description": "The label for category Secret Management in sidebar user_docs"
},
"sidebar.user_docs.category.Terraform": {
"message": "Terraform",
"description": "The label for category Terraform in sidebar user_docs"
},
"sidebar.user_docs.category.Concepts": {
"message": "Concepts",
"description": "The label for category Concepts in sidebar user_docs"
},
"sidebar.user_docs.category.FAQ": {
"message": "FAQ",
"description": "The label for category FAQ in sidebar user_docs"
},
"sidebar.reference.category.Tutorial": {
"message": "Tutorial",
"description": "The label for category Tutorial in sidebar reference"
},
"sidebar.reference.category.Code Lab": {
"message": "Code Lab",
"description": "The label for category Code Lab in sidebar reference"
},
"sidebar.reference.category.Spec": {
"message": "Spec",
"description": "The label for category Spec in sidebar reference"
},
"sidebar.reference.category.Errors and Warnings": {
"message": "Errors and Warnings",
"description": "The label for category Errors and Warnings in sidebar reference"
},
"sidebar.reference.category.System Package": {
"message": "System Package",
"description": "The label for category System Package in sidebar reference"
},
"sidebar.reference.category.Multi-Language": {
"message": "Multi-Language",
"description": "The label for category Multi-Language in sidebar reference"
},
"sidebar.reference.category.Plugin System": {
"message": "Plugin System",
"description": "The label for category Plugin System in sidebar reference"
},
"sidebar.tools.category.Command Line Tools": {
"message": "Command Line Tools",
"description": "The label for category Command Line Tools in sidebar tools"
},
"sidebar.tools.category.KCL Tools": {
"message": "KCL Tools",
"description": "The label for category KCL Tools in sidebar tools"
},
"sidebar.tools.category.Package Management Tools": {
"message": "Package Management Tools",
"description": "The label for category Package Management Tools in sidebar tools"
},
"sidebar.tools.category.Command Reference": {
"message": "Command Reference",
"description": "The label for category Command Reference in sidebar tools"
},
"sidebar.tools.category.OpenAPI Tools": {
"message": "OpenAPI Tools",
"description": "The label for category OpenAPI Tools in sidebar tools"
},
"sidebar.tools.category.IDE": {
"message": "IDE",
"description": "The label for category IDE in sidebar tools"
},
"sidebar.community.category.Community": {
"message": "Community",
"description": "The label for category Community in sidebar community"
},
"sidebar.community.category.Release Policy": {
"message": "Release Policy",
"description": "The label for category Release Policy in sidebar community"
},
"sidebar.community.category.Contribution Guide": {
"message": "Contribution Guide",
"description": "The label for category Contribution Guide in sidebar community"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,8 @@ local a(name) = {

运行时间(考虑到生产环境的实际资源开销,本次测试以单核为准)

| KCL v0.9.3 | Jsonnet v0.20.0 (C++ 版本) | Jsonnet v0.20.0 (Go 版本) | Jsonnet v0.5.0-pre96 (Rust 版本 jrsonnet) | Jsonnet v0.1.2 (Rust 版本 rsjsonnet) |
| ------------------- | ----------------------------- | ------------------------------ | ----------------------------------------- | ------------------------------------ |
| KCL v0.9.3 | Jsonnet v0.20.0 (C++ 版本) | Jsonnet v0.20.0 (Go 版本) | Jsonnet v0.5.0-pre96 (Rust 版本 jrsonnet) | Jsonnet v0.1.2 (Rust 版本 rsjsonnet) |
| ------------------- | ------------------------------ | ----------------------------- | ----------------------------------------- | ------------------------------------ |
| 155 ms (kcl test.k) | 1460 ms (jsonnet test.jsonnet) | 400 ms (jsonnet test.jsonnet) | 153 ms (rsjsonnet test.jsonnet) | 142 ms (jrsonnet test.jsonnet) |

## 小结
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ image: /img/biweekly-newsletter.png
- 包管理工具修复了 push https 协议 OCI registry 失败的问题。
- KCL tree-sitter 新增 sequence operations, selector 支持。


**⛵️ API 更新**

- 重构了 override_file API 的错误信息。
Expand Down
Loading

0 comments on commit 307d24e

Please sign in to comment.