Skip to content

Commit 33e0f8c

Browse files
PeefyPeefy
committed
chore: remove deprecated CLA and links & format all documents
Signed-off-by: peefy <[email protected]>
1 parent e9c48ce commit 33e0f8c

File tree

57 files changed

+278
-340
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+278
-340
lines changed

Diff for: ‎.github/workflows/cla.yml

-38
This file was deleted.

Diff for: ‎blog/2022-09-15-declarative-config-overview/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Different from other languages of the same type in the community, KCL is a stati
167167

168168
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:
169169

170-
- **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.
170+
- **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.
171171
- **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.
172172

173173
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.
@@ -214,7 +214,7 @@ Fig. 8: A K-V validation visualization product based on KCL.
214214

215215
### 2.2 Definition and Abstraction of Complex Configuration Model
216216

217-
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.
217+
As shown in Fig 9, with the help of the KCL OpenAPI tool, we can directly integrate a wide range of well-designed models.
218218

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

Diff for: ‎blog/2022-12-06-kcl-0.4.4-release-blog/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ For more issues, see [https://github.com/kcl-lang/kcl/milestone/2?closed=1](http
258258

259259
## Documents
260260

261-
[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/).
261+
[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).
262262

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

Diff for: ‎blog/2023-04-14-kcl-0.4.6-release/index.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,6 @@ spec:
250250
- containerPort: 80
251251
```
252252

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

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

330329
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.
331330

332-
- See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/kustomize_kcl_plugin) for more information about the Kustomize KCL plugin.
333-
- See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/helm_kcl_plugin) for more information about the Helm KCL Plugin.
334-
- See [here](https://kcl-lang.io/docs/user_docs/guides/working-with-k8s/kpt_kcl_sdk) for more information about the KPT KCL Plugin.
331+
- 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.
332+
- 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.
333+
- 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.
335334

336335
### Multilingual SDK
337336

Diff for: ‎blog/2023-06-29-k8s-sidecar-2/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ k8core.Pod {
4747
}
4848
```
4949

50-
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:
50+
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:
5151

5252
```shell
5353
# 1. Initialize a kcl program package called hello.

Diff for: ‎blog/2023-07-14-kcl-0.5.0-release/index.md

-2
Original file line numberDiff line numberDiff line change
@@ -303,8 +303,6 @@ The kpm tool supports pushing KCL packages through OCI Registry. The default OCI
303303

304304
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.
305305

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

310308
### CI Integrations

Diff for: ‎blog/2023-08-23-biweekly-newsletter/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Thank you to all contributors for their outstanding work over the past two weeks
3636

3737
**📰 Official Website and Use Case Updates**
3838

39-
- 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)_
39+
- KCL package docker.io integration example.
4040
- 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)_
4141
- 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)_
4242

Diff for: ‎blog/2023-08-31-helmfile-kcl-plugin/index.md

-2
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,6 @@ spec:
109109
110110
Specific example codes can be found [here](https://github.com/kcl-lang/krm-kcl/tree/main/examples)
111111
112-
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/
113-
114112
## Conclusion
115113
116114
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!

Diff for: ‎blog/2023-09-06-biweekly-newsletter/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Thank you to all contributors for their outstanding work over the past two weeks
3131
**📰 Official Website and Use Case Updates**
3232

3333
- KCL website adds v0.5.6 documentation version.
34-
- 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)
34+
- Publishing KCL packages to docker.io or ghcr.io registries using Github Actions Example.
3535
- 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)
3636

3737
## Special Thanks

Diff for: ‎blog/2023-10-23-cloud-native-supply-chain-krm-kcl-spec/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -189,5 +189,5 @@ See the [community](https://github.com/kcl-lang/community) for ways to join us.
189189
- [12] KCL IDE Extension: [https://kcl-lang.io/docs/tools/Ide/](https://kcl-lang.io/docs/tools/Ide/)
190190
- [13] ArtifactHub KCL Integration: [https://artifacthub.io/](https://artifacthub.io/)
191191
- [14] KCL Operator: [https://github.com/kcl-lang/kcl-operator](https://github.com/kcl-lang/kcl-operator)
192-
- [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)
192+
- [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)
193193
- [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)

Diff for: ‎blog/2023-11-08-biweekly-newsletter/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ For the model design phase, quick generation of document strings has also been a
5757

5858
### KCL Package Manager Updates
5959

60-
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.
60+
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.
6161

6262
### KCL Language Updates
6363

Diff for: ‎blog/2023-12-25-ten-ways-for-kubernetes-config-management/index.md

-1
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,6 @@ Do you know of other ways? Feel free to add. ❤️
221221
- FluxCD: [https://fluxcd.io/](https://fluxcd.io/)
222222
- Helmfile: [https://helmfile.readthedocs.io/en/latest/](https://helmfile.readthedocs.io/en/latest/)
223223
- CDK8s: [https://cdk8s.io/](https://cdk8s.io/)
224-
- [Helm vs. Kustomize in Kubernetes](https://medium.com/@sushantkapare1717/helm-vs-kustomize-in-kubernetes-cc063bbb4b0e)
225224
- Winglang: [https://github.com/winglang/wing](https://github.com/winglang/wing)
226225
- Plutolang: [https://github.com/pluto-lang/pluto](https://github.com/pluto-lang/pluto)
227226
- [Infrastructure as Code Landscape in 2023](https://blog.terramate.io/infrastructure-as-code-landscape-in-2023-e2dad4fb87d3)

Diff for: ‎docs/reference/xlang-api/go-api.md

+43-43
Original file line numberDiff line numberDiff line change
@@ -93,49 +93,49 @@ x1 = Person {
9393
## Index
9494

9595
- [Go API](#go-api)
96-
- [Index](#index)
97-
- [Constants](#constants)
98-
- [func FormatCode](#func-formatcode)
99-
- [func FormatPath](#func-formatpath)
100-
- [func GetSchemaTypeMapping](#func-getschematypemapping)
101-
- [func InitKclvmPath](#func-initkclvmpath)
102-
- [func InitKclvmRuntime](#func-initkclvmruntime)
103-
- [func LintPath](#func-lintpath)
104-
- [func ListDepFiles](#func-listdepfiles)
105-
- [func ListDownStreamFiles](#func-listdownstreamfiles)
106-
- [func ListUpStreamFiles](#func-listupstreamfiles)
107-
- [func OverrideFile](#func-overridefile)
108-
- [func Validate](#func-validate)
109-
- [func ValidateCode](#func-validatecode)
110-
- [type KCLResult](#type-kclresult)
111-
- [type KCLResultList](#type-kclresultlist)
112-
- [func MustRun](#func-mustrun)
113-
- [func Run](#func-run)
114-
- [func RunFiles](#func-runfiles)
115-
- [type KclType](#type-kcltype)
116-
- [type ListDepFilesOption](#type-listdepfilesoption)
117-
- [type ListDepsOptions](#type-listdepsoptions)
118-
- [type Option](#type-option)
119-
- [func WithCode](#func-withcode)
120-
- [func WithDisableNone](#func-withdisablenone)
121-
- [func WithExternalPkgs](#func-withexternalpkgs)
122-
- [func WithFullTypePath](#func-withfulltypepath)
123-
- [func WithIncludeSchemaTypePath](#func-withincludeschematypepath)
124-
- [func WithKFilenames](#func-withkfilenames)
125-
- [func WithLogger](#func-withlogger)
126-
- [func WithOptions](#func-withoptions)
127-
- [func WithOverrides](#func-withoverrides)
128-
- [func WithPrintOverridesAST](#func-withprintoverridesast)
129-
- [func WithSelectors](#func-withselectors)
130-
- [func WithSettings](#func-withsettings)
131-
- [func WithShowHidden](#func-withshowhidden)
132-
- [func WithSortKeys](#func-withsortkeys)
133-
- [func WithWorkDir](#func-withworkdir)
134-
- [type TestCaseInfo](#type-testcaseinfo)
135-
- [type TestOptions](#type-testoptions)
136-
- [type TestResult](#type-testresult)
137-
- [func Test](#func-test)
138-
- [type ValidateOptions](#type-validateoptions)
96+
- [Index](#index)
97+
- [Constants](#constants)
98+
- [func FormatCode](#func-formatcode)
99+
- [func FormatPath](#func-formatpath)
100+
- [func GetSchemaTypeMapping](#func-getschematypemapping)
101+
- [func InitKclvmPath](#func-initkclvmpath)
102+
- [func InitKclvmRuntime](#func-initkclvmruntime)
103+
- [func LintPath](#func-lintpath)
104+
- [func ListDepFiles](#func-listdepfiles)
105+
- [func ListDownStreamFiles](#func-listdownstreamfiles)
106+
- [func ListUpStreamFiles](#func-listupstreamfiles)
107+
- [func OverrideFile](#func-overridefile)
108+
- [func Validate](#func-validate)
109+
- [func ValidateCode](#func-validatecode)
110+
- [type KCLResult](#type-kclresult)
111+
- [type KCLResultList](#type-kclresultlist)
112+
- [func MustRun](#func-mustrun)
113+
- [func Run](#func-run)
114+
- [func RunFiles](#func-runfiles)
115+
- [type KclType](#type-kcltype)
116+
- [type ListDepFilesOption](#type-listdepfilesoption)
117+
- [type ListDepsOptions](#type-listdepsoptions)
118+
- [type Option](#type-option)
119+
- [func WithCode](#func-withcode)
120+
- [func WithDisableNone](#func-withdisablenone)
121+
- [func WithExternalPkgs](#func-withexternalpkgs)
122+
- [func WithFullTypePath](#func-withfulltypepath)
123+
- [func WithIncludeSchemaTypePath](#func-withincludeschematypepath)
124+
- [func WithKFilenames](#func-withkfilenames)
125+
- [func WithLogger](#func-withlogger)
126+
- [func WithOptions](#func-withoptions)
127+
- [func WithOverrides](#func-withoverrides)
128+
- [func WithPrintOverridesAST](#func-withprintoverridesast)
129+
- [func WithSelectors](#func-withselectors)
130+
- [func WithSettings](#func-withsettings)
131+
- [func WithShowHidden](#func-withshowhidden)
132+
- [func WithSortKeys](#func-withsortkeys)
133+
- [func WithWorkDir](#func-withworkdir)
134+
- [type TestCaseInfo](#type-testcaseinfo)
135+
- [type TestOptions](#type-testoptions)
136+
- [type TestResult](#type-testresult)
137+
- [func Test](#func-test)
138+
- [type ValidateOptions](#type-validateoptions)
139139

140140
## Constants
141141

Diff for: ‎docs/reference/xlang-api/rest-api.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ message ExecProgram_Args {
296296
297297
repeated string k_filename_list = 2;
298298
repeated string k_code_list = 3;
299-
299+
300300
repeated Argument args = 4;
301301
repeated string overrides = 5;
302302
@@ -407,15 +407,15 @@ message ListVariables_Args {
407407
408408
message ListVariables_Result {
409409
map<string, Variable> variables = 1;
410-
repeated string unsupported_codes = 2;
410+
repeated string unsupported_codes = 2;
411411
repeated Error parse_errors = 3;
412412
}
413413
414414
message Variable {
415415
string value = 1;
416-
string type_name = 2;
417-
string op_sym = 3;
418-
repeated Variable list_items = 4;
416+
string type_name = 2;
417+
string op_sym = 3;
418+
repeated Variable list_items = 4;
419419
repeated MapEntry dict_entries = 5;
420420
}
421421

Diff for: ‎docs/reference/xlang-api/wasm-api.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ npm install @kcl-lang/wasm-lib
2121
Write the code
2222

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

2626
async function main() {
2727
const inst = await load();
@@ -33,10 +33,10 @@ schema Person:
3333
3434
p = Person {name = "Alice"}`,
3535
});
36-
console.log(result)
36+
console.log(result);
3737
}
3838

39-
main()
39+
main();
4040
```
4141

4242
The output is

Diff for: ‎docs/tools/Ide/intellij.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ IntelliJ KCL LSP also can be downloaded from the plugin marketplace
2828

2929
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:
3030

31-
For macOS and Linux:
31+
For macOS and Linux:
3232

33-
```bash
34-
which kcl-language-server
35-
```
33+
```bash
34+
which kcl-language-server
35+
```
3636

37-
For Windows:
37+
For Windows:
3838

39-
```bash
40-
where kcl-language-server
41-
```
39+
```bash
40+
where kcl-language-server
41+
```

0 commit comments

Comments
 (0)