Skip to content

Commit 2dfde98

Browse files
authored
Merge pull request #3236 from zhuxiujuan28/docs
【documentation】add https doc & remove whizard and notification-history docs
2 parents e3461d4 + 7060b59 commit 2dfde98

File tree

27 files changed

+966
-47
lines changed

27 files changed

+966
-47
lines changed

content/en/docs/v4.1/02-quickstart/02-access-kubesphere-via-https.adoc

Lines changed: 466 additions & 0 deletions
Large diffs are not rendered by default.

content/en/docs/v4.1/02-quickstart/02-install-an-extension.adoc renamed to content/en/docs/v4.1/02-quickstart/03-install-an-extension.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: "Install and Use Extensions"
33
keywords: "Kubernetes, KubeSphere, quick start, install extensions, example, DevOps, extension features"
44
description: "Introduce all extensions and demonstrate how to install them."
5-
weight: 02
5+
weight: 03
66
---
77

88

content/en/docs/v4.1/02-quickstart/03-control-user-permissions.adoc renamed to content/en/docs/v4.1/02-quickstart/04-control-user-permissions.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: "Control User Permissions"
33
linkTitle: "Create Workspaces, Projects, Users, and Roles"
44
keywords: "Kubernetes, KubeSphere, Quick Start, User Permissions"
55
description: "Learn how to create users and control their permissions by roles in workspaces and projects."
6-
weight: 03
6+
weight: 04
77
---
88

99
ifeval::["{file_output_type}" == "html"]

content/en/docs/v4.1/02-quickstart/05-deploy-wordpress.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ image:/images/ks-qkcp/zh/v4.1/WordPress.png[]
2222

2323
== Prerequisites
2424

25-
* Prepare a project (e.g., **demo-project**) and a user (e.g., **project-regular**). The user should have been invited to the project and has the **operator** role in it. For more information, please refer to link:../03-control-user-permissions/[Control User Permissions].
25+
* Prepare a project (e.g., **demo-project**) and a user (e.g., **project-regular**). The user should have been invited to the project and has the **operator** role in it. For more information, please refer to link:../04-control-user-permissions/[Control User Permissions].
2626

2727
* **KubeSphere Service Mesh** should have been installed and enabled.
2828

content/en/docs/v4.1/02-quickstart/06-deploy-bookinfo.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ image:/images/ks-qkcp/zh/v4.1/bookinfo.png[]
3333

3434
== Prerequisites
3535

36-
* Prepare a project (e.g., **demo-project**) and a user (e.g., **project-regular**). The user should have been invited to the project and has the **operator** role in it. For more information, please refer to link:../03-control-user-permissions/[Control User Permissions].
36+
* Prepare a project (e.g., **demo-project**) and a user (e.g., **project-regular**). The user should have been invited to the project and has the **operator** role in it. For more information, please refer to link:../04-control-user-permissions/[Control User Permissions].
3737

3838
* **KubeSphere Service Mesh** and **KubeSphere Gateway** should have been installed and enabled.
3939

content/en/docs/v4.1/02-quickstart/07-canary-release-example.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This method allows for efficient testing of performance and reliability, helping
1111

1212
== Prerequisites
1313

14-
* Prepare a project (e.g., **demo-project**) and a user (e.g., **project-regular**). The user should have been invited to the project and has the **operator** role in it. For more information, please refer to link:../03-control-user-permissions/[Control User Permissions].
14+
* Prepare a project (e.g., **demo-project**) and a user (e.g., **project-regular**). The user should have been invited to the project and has the **operator** role in it. For more information, please refer to link:../04-control-user-permissions/[Control User Permissions].
1515

1616
* **KubeSphere Service Mesh** and **KubeSphere Gateway** should have been installed and enabled.
1717

content/en/docs/v4.1/11-use-extensions/01-devops/03-how-to-use/01-devops-project-management.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This section demonstrates how to create and manage DevOps projects.
99

1010
== Prerequisites
1111

12-
* A workspace and a user (**project-admin**) have been created. Invite this user to the workspace and assign them the **workspace-self-provisioner** role. For more information, see link:../../../../02-quickstart/03-control-user-permissions[Control User Permissions].
12+
* A workspace and a user (**project-admin**) have been created. Invite this user to the workspace and assign them the **workspace-self-provisioner** role. For more information, see link:../../../../02-quickstart/04-control-user-permissions[Control User Permissions].
1313

1414
* **DevOps** must have been installed and enabled.
1515

content/en/docs/v4.1/11-use-extensions/05-observability-platform/01-platform-services/01-intro.adoc

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The WhizardTelemetry Platform Service is the common service for all extensions o
88

99
**Configuration:**
1010

11-
* Modify the extension configuration of WhizardTelemetry Platform Service in conjunction with WhizardTelemetry Monitoring to enable the Whizard Observability Center. For more information, see link:../../07-whizard/01-enable-whizard/[Whizard Observability Center].
11+
// * Modify the extension configuration of WhizardTelemetry Platform Service in conjunction with WhizardTelemetry Monitoring to enable the Whizard Observability Center. For more information, see link:../../07-whizard/01-enable-whizard/[Whizard Observability Center].
1212

1313
* When configuring the OpenSearch log receivers for WhizardTelemetry Logging, WhizardTelemetry Auditing, WhizardTelemetry Events, and notification history, if you need to use multiple OpenSearch databases, configure them as follows.
1414
+
@@ -112,13 +112,3 @@ whizard-telemetry:
112112
username: admin
113113
password: admin
114114
----
115-
116-
117-
// //note
118-
// [.admon.note,cols="a"]
119-
// |===
120-
// |说明
121-
122-
// |
123-
// 修改 WhizardTelemetry 平台服务的扩展组件配置,可配合 WhizardTelemetry 监控扩展组件,启用 Whizard 可观测中心。有关更多信息,请参阅 link:../../07-whizard/01-enable-whizard/[Whizard 可观测中心]。
124-
// |===

content/en/docs/v4.1/11-use-extensions/05-observability-platform/05-monitoring/_index.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ This section introduces how to use the "WhizardTelemetry Monitoring" extension.
1010

1111
WhizardTelemetry Monitoring is an extension that provides monitoring functions in the WhizardTelemetry Observability Platform, including the Whizard Observability Center. It provides multi-tenant perspective cloud-native resource monitoring capabilities, including real-time and historical data display of core monitoring metrics for objects such as multiple clusters, nodes, workloads, GPU, and K8s control planes.
1212

13-
This section only introduces the monitoring functions in a single-cluster environment. For alerting functions in a single-cluster environment, see link:../06-alerting[WhizardTelemetry Alerting]. For monitoring and alerting functions in a multi-cluster environment, see link:../07-whizard[Whizard Observability Center].
13+
This section only introduces the monitoring functions in a single-cluster environment. For alerting functions in a single-cluster environment, see link:../06-alerting[WhizardTelemetry Alerting].
14+
// For monitoring and alerting functions in a multi-cluster environment, see link:../07-whizard[Whizard Observability Center].
1415

1516
After installing the "WhizardTelemetry Monitoring" extension, the **Monitoring & Alerting** option will be displayed in the left navigation pane of the cluster and project, and services under application workloads in the cluster and project will support **Edit Monitoring Exporter**. The following pages will also display relevant monitoring metrics data:
1617

content/en/docs/v4.1/11-use-extensions/05-observability-platform/06-alerting/03-rule-groups/_index.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ After creating a rule group, the system can generate alerts when specific monito
1616
|Note
1717

1818
|
19-
- {ks_product-en} provides built-in rule groups for clusters, and also supports custom rule groups. If the Whizard Observability Center is enabled, built-in rule groups can only be managed in the Whizard Observability Center. For more information, see link:../../07-whizard/05-alert-management/01-rule-groups/[Whizard Rule Groups].
19+
- {ks_product-en} provides built-in rule groups for clusters, and also supports custom rule groups.
20+
// If the Whizard Observability Center is enabled, built-in rule groups can only be managed in the Whizard Observability Center. For more information, see link:../../07-whizard/05-alert-management/01-rule-groups/[Whizard Rule Groups].
2021

2122
- In projects, only custom rule groups are supported.
2223
|===

0 commit comments

Comments
 (0)