[INLONG-1006][Doc] Add Template Management Document (#1014)

apache · Sep 29, 2024 · 15a7dae · 15a7dae
1 parent e83607c
commit 15a7dae
Show file tree

Hide file tree

Showing 14 changed files with 84 additions and 0 deletions.
diff --git a/docs/administration/img/create_template.png b/docs/administration/img/create_template.png
diff --git a/docs/administration/img/delete_template.png b/docs/administration/img/delete_template.png
diff --git a/docs/administration/img/update_template.png b/docs/administration/img/update_template.png
diff --git a/docs/administration/img/use_template_1.png b/docs/administration/img/use_template_1.png
diff --git a/docs/administration/img/use_template_2.png b/docs/administration/img/use_template_2.png
diff --git a/docs/administration/img/use_template_3.png b/docs/administration/img/use_template_3.png
diff --git a/docs/administration/template_management.md b/docs/administration/template_management.md
@@ -0,0 +1,42 @@
+---
+title: Template Management
+sidebar_position: 7
+---
+
+Template management provides users with the convenient ability to reuse field templates, allowing users to create, modify, and delete templates, as well as reuse configured field template information during data access.
+
+### Create template
+
+Users can generate a commonly used field template information by creating a template:
+
+![](img/create_template.png)
+
+- Template Name：A user-defined name used to identify this field template configuration.
+- Owner：The person responsible for this template; only the person in charge can modify the template's configuration information.
+- Visible Range：The visibility range of this template, including three options: tenant, person in charge, and globally visible. Users within the visibility range can use this template.
+- Source fields：The field information configured for this template.
+
+### Delete template
+
+For templates that are no longer needed, users can perform a deletion operation, and the deleted template will no longer be available.
+
+![](img/delete_template.png)
+
+### Update template
+
+Users can modify an already created template according to their needs.
+
+![](img/update_template.png)
+
+### Use template
+
+After configuring the field template, users can use the pre-configured field template information during data access:
+
+- Select【Ingestion】and click【Detail】
+  ![img.png](img/use_template_1.png)
+- Select【Create】and click【Select Template】.
+  ![img.png](img/use_template_2.png)
+- Select the pre-configured template and click Save.
+  ![img.png](img/use_template_3.png)
+
+  After these steps, you have successfully used the field template.
diff --git a/...N/docusaurus-plugin-content-docs/current/administration/img/create_template.png b/...N/docusaurus-plugin-content-docs/current/administration/img/create_template.png
diff --git a/...N/docusaurus-plugin-content-docs/current/administration/img/delete_template.png b/...N/docusaurus-plugin-content-docs/current/administration/img/delete_template.png
diff --git a/...N/docusaurus-plugin-content-docs/current/administration/img/update_template.png b/...N/docusaurus-plugin-content-docs/current/administration/img/update_template.png
diff --git a/...CN/docusaurus-plugin-content-docs/current/administration/img/use_template_1.png b/...CN/docusaurus-plugin-content-docs/current/administration/img/use_template_1.png
diff --git a/...CN/docusaurus-plugin-content-docs/current/administration/img/use_template_2.png b/...CN/docusaurus-plugin-content-docs/current/administration/img/use_template_2.png
diff --git a/...CN/docusaurus-plugin-content-docs/current/administration/img/use_template_3.png b/...CN/docusaurus-plugin-content-docs/current/administration/img/use_template_3.png
diff --git a/...CN/docusaurus-plugin-content-docs/current/administration/template_management.md b/...CN/docusaurus-plugin-content-docs/current/administration/template_management.md
@@ -0,0 +1,42 @@
+---
+title: 模板管理
+sidebar_position: 7
+---
+
+模板管理主要提供字段模板复用的能力，用户可以在新建、修改、删除模板，并且在进行数据接入时，复用配置好的字段模板信息。
+
+### 新建模板
+
+用户可以通过新建模板来生成一个常用的字段模板信息：
+
+![](img/create_template.png)
+
+- 模板名称：用户自定义名，用来标识此字段模板配置。
+- 责任人：该模板负责人，只有责任人能够修改该模板的配置信息。
+- 可视范围：该模板可视范围，包括租户、责任人、全局可见三个选项。处于可视范围的用户可以使用该模板。
+- 字段信息：该模板配置的字段信息。
+
+### 删除模板
+
+用户可以对已创建的模板进行删除，删除后此模板将停止使用：
+
+![](img/delete_template.png)
+
+### 修改模板
+
+用户可以修改已创建的模板：
+
+![](img/update_template.png)
+
+### 使用模板
+
+用户配置好字段模板后，可以在数据接入中使用已经配置好的字段模板信息：
+
+- 选择【数据接入】，点击【详情】
+  ![img.png](img/use_template_1.png)
+- 选择【新建数据流】，并点击【选择模板】。
+  ![img.png](img/use_template_2.png)
+- 选择【新建数据流】，并点击【选择模板】，选择已经配置好的数，并完善其他配置后点击保存。
+  ![img.png](img/use_template_3.png)
+
+  至此完成了字段模板的使用。