This is an automated email from the ASF dual-hosted git repository.
zhongxjian pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dubbo-kubernetes.git
The following commit(s) were added to refs/heads/master by this push:
new f9ebcce5 [chore] collate docs and deploy dir (#359)
f9ebcce5 is described below
commit f9ebcce598339e266deb8f8b1aa5305caa2faab9
Author: mfordjody <[email protected]>
AuthorDate: Sat Sep 21 17:30:28 2024 +0800
[chore] collate docs and deploy dir (#359)
---
deploy/admin/conf/dubboadmin.yml | 21 ----------------
docs/dubboctl/{Concepts.md => concepts.md} | 0
.../dubboctl_dashboard_admin.md | 2 +-
.../dubboctl_dashboard_grafana.md | 2 +-
.../dubboctl_dashboard_nacos.md | 2 +-
.../dubboctl_dashboard_prometheus.md | 2 +-
.../dubboctl_dashboard_skywalking.md | 2 +-
.../dubboctl_dashboard_zipkin.md | 2 +-
docs/dubboctl/{reference => }/dubboctl_build.md | 2 +-
docs/dubboctl/{reference => }/dubboctl_create.md | 2 +-
docs/dubboctl/dubboctl_dashboard.md | 29 ++++++++++++++++++++++
docs/dubboctl/{reference => }/dubboctl_deploy.md | 2 +-
docs/dubboctl/{envs.md => dubboctl_env.md} | 0
.../{reference/dubboctl.md => dubboctl_help.md} | 6 ++---
...Customize-Template.md => dubboctl_structure.md} | 0
.../{reference => manifest}/dubboctl_manifest.md | 2 +-
.../dubboctl_manifest_diff.md | 0
.../dubboctl_manifest_generate.md | 0
.../dubboctl_manifest_install.md | 0
.../dubboctl_manifest_uninstall.md | 0
.../{reference => profile}/dubboctl_profile.md | 2 +-
.../dubboctl_profile_diff.md | 0
.../dubboctl_profile_list.md | 0
docs/dubboctl/reference/dubboctl_dashboard.md | 29 ----------------------
.../dubboctl_repository.md | 2 +-
.../dubboctl_repository_add.md | 0
.../dubboctl_repository_list.md | 0
.../dubboctl_repository_remove.md | 0
.../dubboctl_repository_rename.md | 0
.../new-policies.md => generate/policies.md} | 0
30 files changed, 44 insertions(+), 65 deletions(-)
diff --git a/deploy/admin/conf/dubboadmin.yml b/deploy/admin/conf/dubboadmin.yml
deleted file mode 100644
index b8d0fdd7..00000000
--- a/deploy/admin/conf/dubboadmin.yml
+++ /dev/null
@@ -1,21 +0,0 @@
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements. See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License. You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-admin:
- registry:
- address: zookeeper://127.0.0.1:2181
- config-center: zookeeper://127.0.0.1:2181
- metadata-report:
- address: zookeeper://127.0.0.1:2181
\ No newline at end of file
diff --git a/docs/dubboctl/Concepts.md b/docs/dubboctl/concepts.md
similarity index 100%
rename from docs/dubboctl/Concepts.md
rename to docs/dubboctl/concepts.md
diff --git a/docs/dubboctl/reference/dubboctl_dashboard_admin.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_admin.md
similarity index 94%
rename from docs/dubboctl/reference/dubboctl_dashboard_admin.md
rename to docs/dubboctl/dashboard/dubboctl_dashboard_admin.md
index 70745e69..e0ad385e 100644
--- a/docs/dubboctl/reference/dubboctl_dashboard_admin.md
+++ b/docs/dubboctl/dashboard/dubboctl_dashboard_admin.md
@@ -27,4 +27,4 @@ dubboctl dashboard admin
### SEE ALSO
-* [dubboctl dashboard](dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
+* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/reference/dubboctl_dashboard_grafana.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_grafana.md
similarity index 94%
rename from docs/dubboctl/reference/dubboctl_dashboard_grafana.md
rename to docs/dubboctl/dashboard/dubboctl_dashboard_grafana.md
index 4e4c601a..83d5b515 100644
--- a/docs/dubboctl/reference/dubboctl_dashboard_grafana.md
+++ b/docs/dubboctl/dashboard/dubboctl_dashboard_grafana.md
@@ -25,4 +25,4 @@ dubboctl dashboard grafana
### SEE ALSO
-* [dubboctl dashboard](dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
+* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/reference/dubboctl_dashboard_nacos.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_nacos.md
similarity index 94%
rename from docs/dubboctl/reference/dubboctl_dashboard_nacos.md
rename to docs/dubboctl/dashboard/dubboctl_dashboard_nacos.md
index 676aea79..059eb139 100644
--- a/docs/dubboctl/reference/dubboctl_dashboard_nacos.md
+++ b/docs/dubboctl/dashboard/dubboctl_dashboard_nacos.md
@@ -25,4 +25,4 @@ dubboctl dashboard nacos
### SEE ALSO
-* [dubboctl dashboard](dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
+* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/reference/dubboctl_dashboard_prometheus.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_prometheus.md
similarity index 94%
rename from docs/dubboctl/reference/dubboctl_dashboard_prometheus.md
rename to docs/dubboctl/dashboard/dubboctl_dashboard_prometheus.md
index 3f6a4c02..8e9152e0 100644
--- a/docs/dubboctl/reference/dubboctl_dashboard_prometheus.md
+++ b/docs/dubboctl/dashboard/dubboctl_dashboard_prometheus.md
@@ -25,4 +25,4 @@ dubboctl dashboard prometheus
### SEE ALSO
-* [dubboctl dashboard](dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
+* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/reference/dubboctl_dashboard_skywalking.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_skywalking.md
similarity index 94%
rename from docs/dubboctl/reference/dubboctl_dashboard_skywalking.md
rename to docs/dubboctl/dashboard/dubboctl_dashboard_skywalking.md
index 5bee615d..185ec053 100644
--- a/docs/dubboctl/reference/dubboctl_dashboard_skywalking.md
+++ b/docs/dubboctl/dashboard/dubboctl_dashboard_skywalking.md
@@ -25,4 +25,4 @@ dubboctl dashboard skywalking
### SEE ALSO
-* [dubboctl dashboard](dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
+* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/reference/dubboctl_dashboard_zipkin.md
b/docs/dubboctl/dashboard/dubboctl_dashboard_zipkin.md
similarity index 94%
rename from docs/dubboctl/reference/dubboctl_dashboard_zipkin.md
rename to docs/dubboctl/dashboard/dubboctl_dashboard_zipkin.md
index 331a89fd..636986ad 100644
--- a/docs/dubboctl/reference/dubboctl_dashboard_zipkin.md
+++ b/docs/dubboctl/dashboard/dubboctl_dashboard_zipkin.md
@@ -25,4 +25,4 @@ dubboctl dashboard zipkin
### SEE ALSO
-* [dubboctl dashboard](dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
+* [dubboctl dashboard](../dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
\ No newline at end of file
diff --git a/docs/dubboctl/reference/dubboctl_build.md
b/docs/dubboctl/dubboctl_build.md
similarity index 90%
rename from docs/dubboctl/reference/dubboctl_build.md
rename to docs/dubboctl/dubboctl_build.md
index f8766e5c..2ec79c6e 100644
--- a/docs/dubboctl/reference/dubboctl_build.md
+++ b/docs/dubboctl/dubboctl_build.md
@@ -19,4 +19,4 @@ Build an application container locally without deploying
### SEE ALSO
-* [dubboctl](dubboctl.md) - Management tool for dubbo-kubernetes
\ No newline at end of file
+* [dubboctl](reference/dubboctl.md) - Management tool for dubbo-kubernetes
\ No newline at end of file
diff --git a/docs/dubboctl/reference/dubboctl_create.md
b/docs/dubboctl/dubboctl_create.md
similarity index 96%
rename from docs/dubboctl/reference/dubboctl_create.md
rename to docs/dubboctl/dubboctl_create.md
index 3f9bb8b3..5ebb4bca 100644
--- a/docs/dubboctl/reference/dubboctl_create.md
+++ b/docs/dubboctl/dubboctl_create.md
@@ -78,4 +78,4 @@ Then you can use dubboctl create -l java -t ruiyi/dubbo
### SEE ALSO
-* [dubboctl](dubboctl.md) - Management tool for dubbo-kubernetes
\ No newline at end of file
+* [dubboctl](reference/dubboctl.md) - Management tool for dubbo-kubernetes
\ No newline at end of file
diff --git a/docs/dubboctl/dubboctl_dashboard.md
b/docs/dubboctl/dubboctl_dashboard.md
new file mode 100644
index 00000000..0fb98de5
--- /dev/null
+++ b/docs/dubboctl/dubboctl_dashboard.md
@@ -0,0 +1,29 @@
+## dubboctl dashboard
+
+Commands help user to open control plane components dashboards directly. Now
support Admin, Grafana, Nacos, Prometheus,
+Skywalking and Zipkin
+
+### Synopsis
+
+Commands help user to open control plane components dashboards directly. Now
support Admin, Grafana, Nacos, Prometheus,
+Skywalking and Zipkin
+
+```
+ -h, --help help for config
+```
+
+### SEE ALSO
+
+* [dubboctl](reference/dubboctl.md) - Management tool for dubbo-kubernetes
+* [dubboctl dashboard admin](dashboard/dubboctl_dashboard_admin.md) - create
PortForward between local address and target
+ component admin pod.
+* [dubboctl dashboard grafana](dashboard/dubboctl_dashboard_grafana.md) -
create PortForward between local address and target
+ component grafana pod.
+* [dubboctl dashboard nacos](dashboard/dubboctl_dashboard_nacos.md) - create
PortForward between local address and target
+ component nacos pod.
+* [dubboctl dashboard prometheus](dashboard/dubboctl_dashboard_prometheus.md)
- create PortForward between local address and
+ target component prometheus pod.
+* [dubboctl dashboard skywalking](dashboard/dubboctl_dashboard_skywalking.md)
- create PortForward between local address and
+ target component skywalking pod.
+* [dubboctl dashboard zipkin](dashboard/dubboctl_dashboard_zipkin.md) - create
PortForward between local address and target
+ component zipkin pod.
\ No newline at end of file
diff --git a/docs/dubboctl/reference/dubboctl_deploy.md
b/docs/dubboctl/dubboctl_deploy.md
similarity index 96%
rename from docs/dubboctl/reference/dubboctl_deploy.md
rename to docs/dubboctl/dubboctl_deploy.md
index 6204f86b..8b17c093 100644
--- a/docs/dubboctl/reference/dubboctl_deploy.md
+++ b/docs/dubboctl/dubboctl_deploy.md
@@ -39,4 +39,4 @@ Deploy an application
### SEE ALSO
-* [dubboctl](dubboctl.md) - Management tool for dubbo-kubernetes
\ No newline at end of file
+* [dubboctl](reference/dubboctl.md) - Management tool for dubbo-kubernetes
\ No newline at end of file
diff --git a/docs/dubboctl/envs.md b/docs/dubboctl/dubboctl_env.md
similarity index 100%
rename from docs/dubboctl/envs.md
rename to docs/dubboctl/dubboctl_env.md
diff --git a/docs/dubboctl/reference/dubboctl.md
b/docs/dubboctl/dubboctl_help.md
similarity index 52%
rename from docs/dubboctl/reference/dubboctl.md
rename to docs/dubboctl/dubboctl_help.md
index a8c53a5d..1c681708 100644
--- a/docs/dubboctl/reference/dubboctl.md
+++ b/docs/dubboctl/dubboctl_help.md
@@ -12,10 +12,10 @@ dubbo control interface
### SEE ALSO
-* [dubboctl manifest](dubboctl_manifest.md) - Commands help user to generate
manifest and install manifest
-* [dubboctl profile](dubboctl_profile.md) - Commands help user to list and
describe profiles
+* [dubboctl manifest](manifest/dubboctl_manifest.md) - Commands help user to
generate manifest and install manifest
+* [dubboctl profile](profile/dubboctl_profile.md) - Commands help user to list
and describe profiles
* [dubboctl dashboard](dubboctl_dashboard.md) - Commands help user to open
control plane components dashboards directly.
-* [dubboctl repository](dubboctl_repository.md) - Manage set of installed
repositories.
+* [dubboctl repository](repository/dubboctl_repository.md) - Manage set of
installed repositories.
* [dubboctl create](dubboctl_create.md) - Create an application
* [dubboctl build](dubboctl_build.md) - Build an application container locally
without deploying
* [dubboctl deploy](dubboctl_deploy.md) - Deploy an application
\ No newline at end of file
diff --git a/docs/dubboctl/Customize-Template.md
b/docs/dubboctl/dubboctl_structure.md
similarity index 100%
rename from docs/dubboctl/Customize-Template.md
rename to docs/dubboctl/dubboctl_structure.md
diff --git a/docs/dubboctl/reference/dubboctl_manifest.md
b/docs/dubboctl/manifest/dubboctl_manifest.md
similarity index 91%
rename from docs/dubboctl/reference/dubboctl_manifest.md
rename to docs/dubboctl/manifest/dubboctl_manifest.md
index cb11b8af..48c98a79 100644
--- a/docs/dubboctl/reference/dubboctl_manifest.md
+++ b/docs/dubboctl/manifest/dubboctl_manifest.md
@@ -12,7 +12,7 @@ Commands help user to generate manifest and install manifest
### SEE ALSO
-* [dubboctl](dubboctl.md) - Management tool for dubbo-kubernetes
+* [dubboctl](../reference/dubboctl.md) - Management tool for dubbo-kubernetes
* [dubboctl manifest diff](dubboctl_manifest_diff.md) - show the difference
between two files or dirs
* [dubboctl manifest generate](dubboctl_manifest_generate.md) - Generate the
manifest of the required components.
* [dubboctl manifest install](dubboctl_manifest_install.md) - Install the
required components directly to the k8s
diff --git a/docs/dubboctl/reference/dubboctl_manifest_diff.md
b/docs/dubboctl/manifest/dubboctl_manifest_diff.md
similarity index 100%
rename from docs/dubboctl/reference/dubboctl_manifest_diff.md
rename to docs/dubboctl/manifest/dubboctl_manifest_diff.md
diff --git a/docs/dubboctl/reference/dubboctl_manifest_generate.md
b/docs/dubboctl/manifest/dubboctl_manifest_generate.md
similarity index 100%
rename from docs/dubboctl/reference/dubboctl_manifest_generate.md
rename to docs/dubboctl/manifest/dubboctl_manifest_generate.md
diff --git a/docs/dubboctl/reference/dubboctl_manifest_install.md
b/docs/dubboctl/manifest/dubboctl_manifest_install.md
similarity index 100%
rename from docs/dubboctl/reference/dubboctl_manifest_install.md
rename to docs/dubboctl/manifest/dubboctl_manifest_install.md
diff --git a/docs/dubboctl/reference/dubboctl_manifest_uninstall.md
b/docs/dubboctl/manifest/dubboctl_manifest_uninstall.md
similarity index 100%
rename from docs/dubboctl/reference/dubboctl_manifest_uninstall.md
rename to docs/dubboctl/manifest/dubboctl_manifest_uninstall.md
diff --git a/docs/dubboctl/reference/dubboctl_profile.md
b/docs/dubboctl/profile/dubboctl_profile.md
similarity index 82%
rename from docs/dubboctl/reference/dubboctl_profile.md
rename to docs/dubboctl/profile/dubboctl_profile.md
index 02e9ced9..766c36f8 100644
--- a/docs/dubboctl/reference/dubboctl_profile.md
+++ b/docs/dubboctl/profile/dubboctl_profile.md
@@ -12,6 +12,6 @@ Commands help user to list and describe profiles
### SEE ALSO
-* [dubboctl](dubboctl.md) - Management tool for dubbo-kubernetes
+* [dubboctl](../reference/dubboctl.md) - Management tool for dubbo-kubernetes
* [dubboctl profile diff](dubboctl_profile_diff.md) - Show the difference
between two profiles
* [dubboctl profile list](dubboctl_profile_list.md) - List all existing
profiles specification
diff --git a/docs/dubboctl/reference/dubboctl_profile_diff.md
b/docs/dubboctl/profile/dubboctl_profile_diff.md
similarity index 100%
rename from docs/dubboctl/reference/dubboctl_profile_diff.md
rename to docs/dubboctl/profile/dubboctl_profile_diff.md
diff --git a/docs/dubboctl/reference/dubboctl_profile_list.md
b/docs/dubboctl/profile/dubboctl_profile_list.md
similarity index 100%
rename from docs/dubboctl/reference/dubboctl_profile_list.md
rename to docs/dubboctl/profile/dubboctl_profile_list.md
diff --git a/docs/dubboctl/reference/dubboctl_dashboard.md
b/docs/dubboctl/reference/dubboctl_dashboard.md
deleted file mode 100644
index 3f5828fa..00000000
--- a/docs/dubboctl/reference/dubboctl_dashboard.md
+++ /dev/null
@@ -1,29 +0,0 @@
-## dubboctl dashboard
-
-Commands help user to open control plane components dashboards directly. Now
support Admin, Grafana, Nacos, Prometheus,
-Skywalking and Zipkin
-
-### Synopsis
-
-Commands help user to open control plane components dashboards directly. Now
support Admin, Grafana, Nacos, Prometheus,
-Skywalking and Zipkin
-
-```
- -h, --help help for config
-```
-
-### SEE ALSO
-
-* [dubboctl](dubboctl.md) - Management tool for dubbo-kubernetes
-* [dubboctl dashboard admin](dubboctl_dashboard_admin.md) - create PortForward
between local address and target
- component admin pod.
-* [dubboctl dashboard grafana](dubboctl_dashboard_grafana.md) - create
PortForward between local address and target
- component grafana pod.
-* [dubboctl dashboard nacos](dubboctl_dashboard_nacos.md) - create PortForward
between local address and target
- component nacos pod.
-* [dubboctl dashboard prometheus](dubboctl_dashboard_prometheus.md) - create
PortForward between local address and
- target component prometheus pod.
-* [dubboctl dashboard skywalking](dubboctl_dashboard_skywalking.md) - create
PortForward between local address and
- target component skywalking pod.
-* [dubboctl dashboard zipkin](dubboctl_dashboard_zipkin.md) - create
PortForward between local address and target
- component zipkin pod.
\ No newline at end of file
diff --git a/docs/dubboctl/reference/dubboctl_repository.md
b/docs/dubboctl/repository/dubboctl_repository.md
similarity index 98%
rename from docs/dubboctl/reference/dubboctl_repository.md
rename to docs/dubboctl/repository/dubboctl_repository.md
index 3e3182c8..a08fa202 100644
--- a/docs/dubboctl/reference/dubboctl_repository.md
+++ b/docs/dubboctl/repository/dubboctl_repository.md
@@ -129,7 +129,7 @@ Flags:
### SEE ALSO
-* [dubboctl](dubboctl.md) - Management tool for dubbo-kubernetes
+* [dubboctl](../reference/dubboctl.md) - Management tool for dubbo-kubernetes
* [dubboctl repository add](dubboctl_repository_add.md)
* [dubboctl repository list](dubboctl_repository_add.md)
* [dubboctl repository remove](dubboctl_repository_remove.md)
diff --git a/docs/dubboctl/reference/dubboctl_repository_add.md
b/docs/dubboctl/repository/dubboctl_repository_add.md
similarity index 100%
rename from docs/dubboctl/reference/dubboctl_repository_add.md
rename to docs/dubboctl/repository/dubboctl_repository_add.md
diff --git a/docs/dubboctl/reference/dubboctl_repository_list.md
b/docs/dubboctl/repository/dubboctl_repository_list.md
similarity index 100%
rename from docs/dubboctl/reference/dubboctl_repository_list.md
rename to docs/dubboctl/repository/dubboctl_repository_list.md
diff --git a/docs/dubboctl/reference/dubboctl_repository_remove.md
b/docs/dubboctl/repository/dubboctl_repository_remove.md
similarity index 100%
rename from docs/dubboctl/reference/dubboctl_repository_remove.md
rename to docs/dubboctl/repository/dubboctl_repository_remove.md
diff --git a/docs/dubboctl/reference/dubboctl_repository_rename.md
b/docs/dubboctl/repository/dubboctl_repository_rename.md
similarity index 100%
rename from docs/dubboctl/reference/dubboctl_repository_rename.md
rename to docs/dubboctl/repository/dubboctl_repository_rename.md
diff --git a/docs/guides/new-policies.md b/docs/generate/policies.md
similarity index 100%
rename from docs/guides/new-policies.md
rename to docs/generate/policies.md