Merge pull request #303 from Peefy/indexsignature-code-style

docs: add code style for schema index signatures

Author: Peefy

blog/2024-02-05-lfx-guide/index.md

@@ -9,8 +9,8 @@ tags: [KCL, LFX-Mentorship]
 
 [KCL](https://github.com/kcl-lang) is a constraint-based record and functional language hosted by Cloud Native Computing Foundation (CNCF) that enhances the writing of complex configurations, including those for cloud-native scenarios. With its advanced programming language technology and practices, KCL is dedicated to promoting better modularity, scalability, and stability for configurations. It enables simpler logic writing and offers ease of automation APIs and integration with homegrown systems.
 
-**_KCL Website: [https://kcl-lang.io](https://kcl-lang.io)_**\
-**_KCL Github Repo: [https://github.com/kcl-lang](https://github.com/kcl-lang)_**
++ **_KCL Website: [https://kcl-lang.io](https://kcl-lang.io)_**
++ **_KCL Github Repo: [https://github.com/kcl-lang](https://github.com/kcl-lang)_**
 
 For those interested in cloud-native, platform engineering,compiler, package management tools, and IDEs, we invite you to apply for the 2024 Spring Linux Foundation LFX Mentorship project. You can earn a minimum of $3000 for completing the project! Apply now!
 

docs/reference/lang/spec/codestyle.md

@@ -572,6 +572,22 @@ print("", end='')  # recommended
 print("", end = '')  # non-recommended
 ```
 
+### Index Signature
+
+- It is recommended to place the schema index signature before the schema attribute instead of mixed placement.
+
+```python
+schema ConfigReCommended:
+    [...str]: str # recommended
+    name: str
+    image: str
+
+schema ConfigNonReCommended:
+    name: str
+    [...str]: str # non-recommended
+    image: str
+```
+
 ## Keywords
 
 - Only one space is usually reserved around the keyword, such as `schema`, `mixin`, `is` and `not`, etc.

i18n/zh-CN/docusaurus-plugin-content-blog/2024-02-05-lfx-guide/index.md

@@ -9,8 +9,8 @@ tags: [KCL, Biweekly-Newsletter]
 
 [KCL](https://github.com/kcl-lang) 是一个 CNCF 基金会托管的基于约束的记录及函数语言，期望通过成熟的编程语言技术和实践来改进对大量繁杂配置比如云原生 Kubernetes 配置场景的编写，致力于构建围绕配置的更好的模块化、扩展性和稳定性，更简单的逻辑编写，以及更简单的自动化和生态工具集成。
 
-**_KCL 官网：[https://kcl-lang.io](https://kcl-lang.io)_**\
-**_KCL Github 仓库：[https://github.com/kcl-lang](https://github.com/kcl-lang)_**
++ **_KCL 官网：[https://kcl-lang.io](https://kcl-lang.io)_**
++ **_KCL Github 仓库：[https://github.com/kcl-lang](https://github.com/kcl-lang)_**
 
 对云原生、平台工程、语言编译器、语言包管理工具和语言 IDE 感兴趣的小伙伴，我们邀请你申请 KCL 的 2024 春季 Linux 基金会 LFX Mentorship 项目，完成项目有最低 3000 美金的奖励哦！快来申请吧！
 

i18n/zh-CN/docusaurus-plugin-content-docs/current/reference/lang/spec/codestyle.md

@@ -572,6 +572,22 @@ print("", end='')  # recommended
 print("", end = '')  # non-recommended
 ```
 
+### Index Signature
+
+- It is recommended to place the schema index signature before the schema attribute instead of mixed placement.
+
+```python
+schema ConfigReCommended:
+    [...str]: str # recommended
+    name: str
+    image: str
+
+schema ConfigNonReCommended:
+    name: str
+    [...str]: str # non-recommended
+    image: str
+```
+
 ## Keywords
 
 - Only one space is usually reserved around the keyword, such as `schema`, `mixin`, `is` and `not`, etc.

i18n/zh-CN/docusaurus-plugin-content-docs/version-0.8.0/reference/lang/spec/codestyle.md

@@ -572,6 +572,22 @@ print("", end='')  # recommended
 print("", end = '')  # non-recommended
 ```
 
+### Index Signature
+
+- It is recommended to place the schema index signature before the schema attribute instead of mixed placement.
+
+```python
+schema ConfigReCommended:
+    [...str]: str # recommended
+    name: str
+    image: str
+
+schema ConfigNonReCommended:
+    name: str
+    [...str]: str # non-recommended
+    image: str
+```
+
 ## Keywords
 
 - Only one space is usually reserved around the keyword, such as `schema`, `mixin`, `is` and `not`, etc.

versioned_docs/version-0.8.0/reference/lang/spec/codestyle.md

@@ -572,6 +572,22 @@ print("", end='')  # recommended
 print("", end = '')  # non-recommended
 ```
 
+### Index Signature
+
+- It is recommended to place the schema index signature before the schema attribute instead of mixed placement.
+
+```python
+schema ConfigReCommended:
+    [...str]: str # recommended
+    name: str
+    image: str
+
+schema ConfigNonReCommended:
+    name: str
+    [...str]: str # non-recommended
+    image: str
+```
+
 ## Keywords
 
 - Only one space is usually reserved around the keyword, such as `schema`, `mixin`, `is` and `not`, etc.