Skip to content

chore: remove deprecated CLA and links & format all documents #399

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

Merged
merged 1 commit into from
Jul 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 0 additions & 38 deletions .github/workflows/cla.yml

This file was deleted.

4 changes: 2 additions & 2 deletions blog/2022-09-15-declarative-config-overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Different from other languages of the same type in the community, KCL is a stati

The core features of KCL are its **modeling** and **constraint** capabilities, and the basic functions of KCL revolve around the two core features. In addition, KCL follows the user-centric configuration concept to design its basic functions, which can be understood from two aspects:

- **Domain model-centric configuration view**: With the rich features of KCL language and [KCL OpenAPI](https://kcl-lang.io/docs/tools/cli/openapi/) tools, we can directly integrate a wide range of well-designed models in the community into KCL (such as the K8s resource model). We can also design and implement our own KCL models or libraries according to different scenarios, forming a complete set of domain models for other configuration end users to use.
- **Domain model-centric configuration view**: With the rich features of KCL language and KCL OpenAPI tools, we can directly integrate a wide range of well-designed models in the community into KCL (such as the K8s resource model). We can also design and implement our own KCL models or libraries according to different scenarios, forming a complete set of domain models for other configuration end users to use.
- **End user-centric configuration view**: With KCL's code encapsulation, abstraction and reuse capabilities, the model architecture can be further abstracted and simplified (for example, the K8s resource model is abstracted into an application-centered server model) to **minimize the end user configuration input**, simplify the user's configuration interface, and facilitate manual or automatic API modification.

No matter what configuration view is centered on, for configuration code, there are requirements for configuration data constraints, such as type constraints, required/optional constraints on configuration attributes, range constraints, and immutability constraints. This is also one of the core issues KCL is committed to solving. KCL mainly contains the core features shown in Fig. 5.
Expand Down Expand Up @@ -214,7 +214,7 @@ Fig. 8: A K-V validation visualization product based on KCL.

### 2.2 Definition and Abstraction of Complex Configuration Model

As shown in Fig 9, with the help of the [KCL OpenAPI](https://kcl-lang.io/docs/tools/cli/openapi/) tool, we can directly integrate a wide range of well-designed models.
As shown in Fig 9, with the help of the KCL OpenAPI tool, we can directly integrate a wide range of well-designed models.

![](/img/blog/2022-09-15-declarative-config-overview/09-kcl-modeling.png)

Expand Down
2 changes: 1 addition & 1 deletion blog/2022-12-06-kcl-0.4.4-release-blog/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,7 @@ For more issues, see [https://github.com/kcl-lang/kcl/milestone/2?closed=1](http

## Documents

[KCL website](https://kcl-lang.github.io/) preliminary establishment and improvement of Kubernetes scenarios [related documents](https://kcl-lang.github.io/docs/user_docs/guides/working-with-k8s/).
[KCL website](https://kcl-lang.github.io/) preliminary establishment and improvement of Kubernetes scenarios [related documents](https://kcl-lang.github.io/docs/user_docs/guides/working-with-k8s/overview).

For more information, see [https://kcl-lang.github.io/](https://kcl-lang.github.io/)

Expand Down
7 changes: 3 additions & 4 deletions blog/2023-04-14-kcl-0.4.6-release/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,6 @@ spec:
- containerPort: 80
```

- See [here](https://kcl-lang.io/docs/user_docs/guides/package-management/overview) for more information about the **kpm** tool.
- See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-konfig/overview) for more information about the **konfig** model.

## Integrations
Expand Down Expand Up @@ -329,9 +328,9 @@ In the YAML configuration mentioned above, we only wrote one line of KCL code to

In addition, we have provided commonly used container and service configuration mutation and validation KCL models for Kustomize/Helm/KPT tools and will continue to improve them.

- See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/kustomize_kcl_plugin) for more information about the Kustomize KCL plugin.
- See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/helm_kcl_plugin) for more information about the Helm KCL Plugin.
- See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/kpt_kcl_sdk) for more information about the KPT KCL Plugin.
- See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/mutate-manifests/kubectl-kcl-plugin) for more information about the Kustomize KCL plugin.
- See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/mutate-manifests/helm-kcl-plugin) for more information about the Helm KCL Plugin.
- See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/mutate-manifests/kpt-kcl-sdk) for more information about the KPT KCL Plugin.

### Multilingual SDK

Expand Down
2 changes: 1 addition & 1 deletion blog/2023-06-29-k8s-sidecar-2/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ k8core.Pod {
}
```

Here, the `import` statement imports the `k8s/api/core/v1` package from the k8s package, and the `Pod` structure definition corresponds to the `Pod` model. The default values for apiVersion and kind have already been included, so we only need to add the `metadata.name` and `spec.containers` properties (KCL also provides syntax sugar for some multi-level nested properties). We can use the [kpm package management tool](https://kcl-lang.io/docs/user_docs/guides/package-management/installation/) to create a KCL program to define a Pod resource and execute the program to get the corresponding YAML:
Here, the `import` statement imports the `k8s/api/core/v1` package from the k8s package, and the `Pod` structure definition corresponds to the `Pod` model. The default values for apiVersion and kind have already been included, so we only need to add the `metadata.name` and `spec.containers` properties (KCL also provides syntax sugar for some multi-level nested properties). We can use the package management tool to create a KCL program to define a Pod resource and execute the program to get the corresponding YAML:

```shell
# 1. Initialize a kcl program package called hello.
Expand Down
2 changes: 0 additions & 2 deletions blog/2023-07-14-kcl-0.5.0-release/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,8 +303,6 @@ The kpm tool supports pushing KCL packages through OCI Registry. The default OCI

You can browse the KCL package you need here. We currently provide the KCL package for k8s, which supports all versions of k8s from 1.14 to 1.27. Welcome to open [Issues](https://github.com/kcl-lang/kpm/issues) to co build KCL models.

See [here](https://kcl-lang.io/docs/user_docs/guides/package-management/overview) for more information about the **kpm** tool.

## Integrations

### CI Integrations
Expand Down
2 changes: 1 addition & 1 deletion blog/2023-08-23-biweekly-newsletter/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Thank you to all contributors for their outstanding work over the past two weeks

**📰 Official Website and Use Case Updates**

- KCL package docker.io integration example: _[https://github.com/kcl-lang/kpm/blob/main/docs/publish_to_docker_reg.md](https://github.com/kcl-lang/kpm/blob/main/docs/publish_to_docker_reg.md)_
- KCL package docker.io integration example.
- KCL Gitlab CI integration example: _[https://kcl-lang.io/docs/user_docs/guides/ci-integration/gitlab-ci](https://kcl-lang.io/docs/user_docs/guides/ci-integration/gitlab-ci)_
- KCL Vault and Vals Integration example: _[https://kcl-lang.io/docs/user_docs/guides/secret-management/vault](https://kcl-lang.io/docs/user_docs/guides/secret-management/vault)_

Expand Down
2 changes: 0 additions & 2 deletions blog/2023-08-31-helmfile-kcl-plugin/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,6 @@ spec:

Specific example codes can be found [here](https://github.com/kcl-lang/krm-kcl/tree/main/examples)

If you want to contribute more KCL code repositories, feel free to contact us and refer to the documentation for contribution: https://kcl-lang.io/zh-CN/docs/user_docs/guides/package-management/share_your_pkg/

## Conclusion

This blog provided a quick getting started guide to help you master the basics of the Helmfile KCL Plugin in just 5 minutes. Now, you can start using this powerful tool to simplify and optimize your Kubernetes application deployment process!
Expand Down
2 changes: 1 addition & 1 deletion blog/2023-09-06-biweekly-newsletter/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Thank you to all contributors for their outstanding work over the past two weeks
**📰 Official Website and Use Case Updates**

- KCL website adds v0.5.6 documentation version.
- Publishing KCL packages to docker.io or ghcr.io registries using Github Actions Example: [https://github.com/kcl-lang/kpm/blob/main/docs/push_by_github_action.md](https://github.com/kcl-lang/kpm/blob/main/docs/push_by_github_action.md)
- Publishing KCL packages to docker.io or ghcr.io registries using Github Actions Example.
- KCL Operator example: [https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/mutate-manifests/kcl-operator](https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/mutate-manifests/kcl-operator)

## Special Thanks
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,5 +189,5 @@ See the [community](https://github.com/kcl-lang/community) for ways to join us.
- [12] KCL IDE Extension: [https://kcl-lang.io/docs/tools/Ide/](https://kcl-lang.io/docs/tools/Ide/)
- [13] ArtifactHub KCL Integration: [https://artifacthub.io/](https://artifacthub.io/)
- [14] KCL Operator: [https://github.com/kcl-lang/kcl-operator](https://github.com/kcl-lang/kcl-operator)
- [15] Terraform KCL Policy: [https://kcl-lang.io/docs/user_docs/guides/working-with-terraform/validation](https://kcl-lang.io/docs/user_docs/guides/[]working-with-terraform/validation)
- [15] Terraform KCL Policy: [https://kcl-lang.io/docs/user_docs/guides/working-with-terraform/validation](https://kcl-lang.io/docs/user_docs/guides/working-with-terraform/validation)
- [16] GitOps using KCL: [https://kcl-lang.io/docs/user_docs/guides/gitops/gitops-quick-start](https://kcl-lang.io/docs/user_docs/guides/gitops/gitops-quick-start)
2 changes: 1 addition & 1 deletion blog/2023-11-08-biweekly-newsletter/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ For the model design phase, quick generation of document strings has also been a

### KCL Package Manager Updates

The package management tool has now interconnected the core workflow of KCL package creation, update, code review, and release. Based on this, over 120+ out-of-the-box KCL model packages have been added. Users can refer to the [Writing and Publishing Kubernetes KCL Code Packages guide](https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/publish-modules/) to start using them immediately.
The package management tool has now interconnected the core workflow of KCL package creation, update, code review, and release. Based on this, over 120+ out-of-the-box KCL model packages have been added.

### KCL Language Updates

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,6 @@ Do you know of other ways? Feel free to add. ❤️
- FluxCD: [https://fluxcd.io/](https://fluxcd.io/)
- Helmfile: [https://helmfile.readthedocs.io/en/latest/](https://helmfile.readthedocs.io/en/latest/)
- CDK8s: [https://cdk8s.io/](https://cdk8s.io/)
- [Helm vs. Kustomize in Kubernetes](https://medium.com/@sushantkapare1717/helm-vs-kustomize-in-kubernetes-cc063bbb4b0e)
- Winglang: [https://github.com/winglang/wing](https://github.com/winglang/wing)
- Plutolang: [https://github.com/pluto-lang/pluto](https://github.com/pluto-lang/pluto)
- [Infrastructure as Code Landscape in 2023](https://blog.terramate.io/infrastructure-as-code-landscape-in-2023-e2dad4fb87d3)
86 changes: 43 additions & 43 deletions docs/reference/xlang-api/go-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,49 +93,49 @@ x1 = Person {
## Index

- [Go API](#go-api)
- [Index](#index)
- [Constants](#constants)
- [func FormatCode](#func-formatcode)
- [func FormatPath](#func-formatpath)
- [func GetSchemaTypeMapping](#func-getschematypemapping)
- [func InitKclvmPath](#func-initkclvmpath)
- [func InitKclvmRuntime](#func-initkclvmruntime)
- [func LintPath](#func-lintpath)
- [func ListDepFiles](#func-listdepfiles)
- [func ListDownStreamFiles](#func-listdownstreamfiles)
- [func ListUpStreamFiles](#func-listupstreamfiles)
- [func OverrideFile](#func-overridefile)
- [func Validate](#func-validate)
- [func ValidateCode](#func-validatecode)
- [type KCLResult](#type-kclresult)
- [type KCLResultList](#type-kclresultlist)
- [func MustRun](#func-mustrun)
- [func Run](#func-run)
- [func RunFiles](#func-runfiles)
- [type KclType](#type-kcltype)
- [type ListDepFilesOption](#type-listdepfilesoption)
- [type ListDepsOptions](#type-listdepsoptions)
- [type Option](#type-option)
- [func WithCode](#func-withcode)
- [func WithDisableNone](#func-withdisablenone)
- [func WithExternalPkgs](#func-withexternalpkgs)
- [func WithFullTypePath](#func-withfulltypepath)
- [func WithIncludeSchemaTypePath](#func-withincludeschematypepath)
- [func WithKFilenames](#func-withkfilenames)
- [func WithLogger](#func-withlogger)
- [func WithOptions](#func-withoptions)
- [func WithOverrides](#func-withoverrides)
- [func WithPrintOverridesAST](#func-withprintoverridesast)
- [func WithSelectors](#func-withselectors)
- [func WithSettings](#func-withsettings)
- [func WithShowHidden](#func-withshowhidden)
- [func WithSortKeys](#func-withsortkeys)
- [func WithWorkDir](#func-withworkdir)
- [type TestCaseInfo](#type-testcaseinfo)
- [type TestOptions](#type-testoptions)
- [type TestResult](#type-testresult)
- [func Test](#func-test)
- [type ValidateOptions](#type-validateoptions)
- [Index](#index)
- [Constants](#constants)
- [func FormatCode](#func-formatcode)
- [func FormatPath](#func-formatpath)
- [func GetSchemaTypeMapping](#func-getschematypemapping)
- [func InitKclvmPath](#func-initkclvmpath)
- [func InitKclvmRuntime](#func-initkclvmruntime)
- [func LintPath](#func-lintpath)
- [func ListDepFiles](#func-listdepfiles)
- [func ListDownStreamFiles](#func-listdownstreamfiles)
- [func ListUpStreamFiles](#func-listupstreamfiles)
- [func OverrideFile](#func-overridefile)
- [func Validate](#func-validate)
- [func ValidateCode](#func-validatecode)
- [type KCLResult](#type-kclresult)
- [type KCLResultList](#type-kclresultlist)
- [func MustRun](#func-mustrun)
- [func Run](#func-run)
- [func RunFiles](#func-runfiles)
- [type KclType](#type-kcltype)
- [type ListDepFilesOption](#type-listdepfilesoption)
- [type ListDepsOptions](#type-listdepsoptions)
- [type Option](#type-option)
- [func WithCode](#func-withcode)
- [func WithDisableNone](#func-withdisablenone)
- [func WithExternalPkgs](#func-withexternalpkgs)
- [func WithFullTypePath](#func-withfulltypepath)
- [func WithIncludeSchemaTypePath](#func-withincludeschematypepath)
- [func WithKFilenames](#func-withkfilenames)
- [func WithLogger](#func-withlogger)
- [func WithOptions](#func-withoptions)
- [func WithOverrides](#func-withoverrides)
- [func WithPrintOverridesAST](#func-withprintoverridesast)
- [func WithSelectors](#func-withselectors)
- [func WithSettings](#func-withsettings)
- [func WithShowHidden](#func-withshowhidden)
- [func WithSortKeys](#func-withsortkeys)
- [func WithWorkDir](#func-withworkdir)
- [type TestCaseInfo](#type-testcaseinfo)
- [type TestOptions](#type-testoptions)
- [type TestResult](#type-testresult)
- [func Test](#func-test)
- [type ValidateOptions](#type-validateoptions)

## Constants

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/xlang-api/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ message ExecProgram_Args {

repeated string k_filename_list = 2;
repeated string k_code_list = 3;

repeated Argument args = 4;
repeated string overrides = 5;

Expand Down Expand Up @@ -407,15 +407,15 @@ message ListVariables_Args {

message ListVariables_Result {
map<string, Variable> variables = 1;
repeated string unsupported_codes = 2;
repeated string unsupported_codes = 2;
repeated Error parse_errors = 3;
}

message Variable {
string value = 1;
string type_name = 2;
string op_sym = 3;
repeated Variable list_items = 4;
string type_name = 2;
string op_sym = 3;
repeated Variable list_items = 4;
repeated MapEntry dict_entries = 5;
}

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/xlang-api/wasm-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ npm install @kcl-lang/wasm-lib
Write the code

```typescript
import { load, invokeKCLRun } from '@kcl-lang/wasm-lib'
import { load, invokeKCLRun } from "@kcl-lang/wasm-lib";

async function main() {
const inst = await load();
Expand All @@ -33,10 +33,10 @@ schema Person:

p = Person {name = "Alice"}`,
});
console.log(result)
console.log(result);
}

main()
main();
```

The output is
Expand Down
16 changes: 8 additions & 8 deletions docs/tools/Ide/intellij.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ IntelliJ KCL LSP also can be downloaded from the plugin marketplace

Additionally, you need to install the [kcl-language-server](https://www.kcl-lang.io/docs/user_docs/getting-started/install#install-language-server) and verify that the `kcl-language-server` command is in your PATH. Here are the steps for different operating systems:

For macOS and Linux:
For macOS and Linux:

```bash
which kcl-language-server
```
```bash
which kcl-language-server
```

For Windows:
For Windows:

```bash
where kcl-language-server
```
```bash
where kcl-language-server
```
Loading
Loading