You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dubbo.apache.org by li...@apache.org on 2022/04/25 01:40:43 UTC
[dubbo-website] branch refactor/docs updated: facade menu (#1073)
This is an automated email from the ASF dual-hosted git repository.
liujun pushed a commit to branch refactor/docs
in repository https://gitbox.apache.org/repos/asf/dubbo-website.git
The following commit(s) were added to refs/heads/refactor/docs by this push:
new b222cd2098 facade menu (#1073)
b222cd2098 is described below
commit b222cd209892f82b43a906362ec9f344df329ac5
Author: ken.lj <ke...@gmail.com>
AuthorDate: Mon Apr 25 09:40:39 2022 +0800
facade menu (#1073)
---
.github/workflows/build_and_deploy.yml | 8 ++------
config.toml | 18 ++++++++--------
content/cn/_index.html | 2 +-
content/cn/facade-docs/_index.md | 24 ++++++++++++++++++----
content/cn/facade-docs/contact /_index.md | 6 +++---
content/cn/facade-docs/how/_index.md | 8 --------
content/cn/facade-docs/mannual/Golang.md | 11 ++++++++++
.../{why/advantage.md => mannual/Java.md} | 4 ++--
.../{how/quick-start.md => mannual/_index.md} | 19 ++++++++++-------
.../{how/quick-start.md => quickstart/_index.md} | 8 ++++----
content/cn/facade-docs/tasks/_index.md | 11 ++++++++++
content/cn/facade-docs/what/_index.md | 4 ++--
content/cn/facade-docs/what/ecosystem.md | 2 +-
content/cn/facade-docs/what/overview.md | 2 +-
content/cn/facade-docs/whatsnew/_index.md | 7 +++++++
content/cn/facade-docs/whatsnew/mesh.md | 9 ++++++++
.../cn/facade-docs/whatsnew/servicediscovery3.md | 9 ++++++++
content/cn/facade-docs/whatsnew/triple.md | 9 ++++++++
content/cn/facade-docs/why/_index.md | 11 ----------
19 files changed, 113 insertions(+), 59 deletions(-)
diff --git a/.github/workflows/build_and_deploy.yml b/.github/workflows/build_and_deploy.yml
index 62eb7334d0..80f09a5b6c 100644
--- a/.github/workflows/build_and_deploy.yml
+++ b/.github/workflows/build_and_deploy.yml
@@ -3,11 +3,7 @@ name: Website Deploy
on:
push:
branches:
- - master
- pull_request:
- types: [ opened, synchronize, reopened, closed ]
- branches:
- - master
+ - refactor/docs
jobs:
@@ -38,7 +34,7 @@ jobs:
run: cp .htaccess ./public
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
- if: github.ref == 'refs/heads/master'
+ if: github.ref == 'refs/heads/refactor/docs'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: asf-site
diff --git a/config.toml b/config.toml
index 38e113d804..5e190c2814 100644
--- a/config.toml
+++ b/config.toml
@@ -1,4 +1,4 @@
-baseURL = "https://dubbo.apache.org/"
+baseURL = "https://chickenlj.github.io/incubator-dubbo-website/"
languageCode = "en-us"
title = "Apache Dubbo"
theme = ["docsy"]
@@ -96,23 +96,23 @@ cn_ecosystem_docs_menu = "高级文档"
[[params.ecosystems.docs]]
ecosystem = "Dubbo Java SDK"
- en.docs.url = "https://dubbo.apache.org/en/java-sdk/"
- cn.docs.url = "https://dubbo.apache.org/cn/java-sdk/"
+ en.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/en/java-sdk/"
+ cn.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/cn/java-sdk/"
[[params.ecosystems.docs]]
ecosystem = "Dubbo Golang SDK"
- en.docs.url = "https://dubbo.apache.org/en/golang-sdk/"
- cn.docs.url = "https://dubbo.apache.org/cn/golang-sdk/"
+ en.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/en/golang-sdk/"
+ cn.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/cn/golang-sdk/"
[[params.ecosystems.docs]]
ecosystem = "Dubbo Pixiu"
- en.docs.url = "https://dubbo.apache.org/en/pixiu/"
- cn.docs.url = "https://dubbo.apache.org/cn/pixiu/"
+ en.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/en/pixiu/"
+ cn.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/cn/pixiu/"
[[params.ecosystems.docs]]
ecosystem = "Dubbo Admin"
- en.docs.url = "https://dubbo.apache.org/en/admin/"
- cn.docs.url = "https://dubbo.apache.org/cn/admin/"
+ en.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/en/admin/"
+ cn.docs.url = "https://chickenlj.github.io/incubator-dubbo-website/cn/admin/"
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
github_repo = "https://github.com/apache/dubbo-website"
diff --git a/content/cn/_index.html b/content/cn/_index.html
index 002ebe80fa..2609f3a8ee 100644
--- a/content/cn/_index.html
+++ b/content/cn/_index.html
@@ -6,7 +6,7 @@ linkTitle = "Apache Dubbo Website"
{{< blocks/cover title="Apache Dubbo" image_anchor="top" height="auto" color="primary" >}}
<div class="mx-auto">
- <a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/facade-docs/how/quick-start" >}}">
+ <a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/facade-docs/quickstart" >}}">
快速开始 <i class="fas fa-arrow-alt-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-light mr-3 mb-4" href="/cn/blog/2020/05/18/过往版本/">
diff --git a/content/cn/facade-docs/_index.md b/content/cn/facade-docs/_index.md
index a54b588e3d..2cc92d08ef 100755
--- a/content/cn/facade-docs/_index.md
+++ b/content/cn/facade-docs/_index.md
@@ -3,14 +3,30 @@
type: docs
title: "文档"
linkTitle: "文档"
-weight: 20
+no_list: true
menu:
main:
weight: 10
- name: "文档"
-
---
-欢迎阅读 Dubbo 文档
+Dubbo 是一款包含多种语言实现（Java、Golang等）的 RPC 服务框架，在这里可以查看 Dubbo 核心概念以及每种语言实现的 Demo、用户手册等。
+* **如果你是第一次接触 Dubbo**，可以通过以下链接快速了解 Dubbo:
+ * 什么是 Dubbo
+ * 核心概念与架构
+ * 选择相应**语言 SDK 实现**，通过**快速开始**体验 Dubbo
+* 想了解更多 Dubbo 特性与使用细节?
+ * 选择相应**语言 SDK 实现**，并参考**高级特性**或**参考手册**
+ * Dubbo 生态
+* 老用户，想快速了解 **Dubbo 3.0** 相关知识
+ * 3.0 特性一览
+ * 查看相应语言 SDK 实现，了解升级与兼容性
+
+#### 相关链接
+Dubbo 的多语言实现及文档:
+
+Language | OS | Compilers/SDK
+-- | -- | --
+Go|Windows, Linux, Mac|Go 1.13+
+Java|Windows, Linux, Mac|Java 8+
diff --git a/content/cn/facade-docs/contact /_index.md b/content/cn/facade-docs/contact /_index.md
index 49d8455ed0..5a921e1334 100755
--- a/content/cn/facade-docs/contact /_index.md
+++ b/content/cn/facade-docs/contact /_index.md
@@ -1,10 +1,10 @@
---
type: docs
-title: "如何联系Dubbo社区？"
-linkTitle: "如何联系Dubbo社区？"
+title: "联系社区"
+linkTitle: "联系社区"
description: ""
-weight: 4
+weight: 6
---
diff --git a/content/cn/facade-docs/how/_index.md b/content/cn/facade-docs/how/_index.md
deleted file mode 100755
index ba1dd3efc2..0000000000
--- a/content/cn/facade-docs/how/_index.md
+++ /dev/null
@@ -1,8 +0,0 @@
-
----
-type: docs
-title: "如何用Dubbo？"
-linkTitle: "如何使用Dubbo？"
-weight: 3
----
-
diff --git a/content/cn/facade-docs/mannual/Golang.md b/content/cn/facade-docs/mannual/Golang.md
new file mode 100755
index 0000000000..cbd0b12e05
--- /dev/null
+++ b/content/cn/facade-docs/mannual/Golang.md
@@ -0,0 +1,11 @@
+
+---
+type: docs
+title: "Golang SDK"
+linkTitle: "golang"
+description: ""
+weight: 2
+---
+
+
+
diff --git a/content/cn/facade-docs/why/advantage.md b/content/cn/facade-docs/mannual/Java.md
similarity index 57%
rename from content/cn/facade-docs/why/advantage.md
rename to content/cn/facade-docs/mannual/Java.md
index a251f4cfb9..f222bed0e3 100755
--- a/content/cn/facade-docs/why/advantage.md
+++ b/content/cn/facade-docs/mannual/Java.md
@@ -1,8 +1,8 @@
---
type: docs
-title: "优势"
-linkTitle: "优势"
+title: "Java SDK"
+linkTitle: "java"
description: ""
weight: 1
---
diff --git a/content/cn/facade-docs/how/quick-start.md b/content/cn/facade-docs/mannual/_index.md
old mode 100644
new mode 100755
similarity index 82%
copy from content/cn/facade-docs/how/quick-start.md
copy to content/cn/facade-docs/mannual/_index.md
index 293f45944b..e5eee941a3
--- a/content/cn/facade-docs/how/quick-start.md
+++ b/content/cn/facade-docs/mannual/_index.md
@@ -1,10 +1,16 @@
+
---
type: docs
-title: "快速开始"
-linkTitle: "快速开始"
-weight: 3
+title: "用户手册"
+linkTitle: "用户手册"
+weight: 5
+no_list: true
+nav_children: section
+notoc: true
+simple_list: true
---
+
{{< blocks/section color="white" height="auto">}}
<div class="td-content list-page">
<div class="lead"></div><header class="article-meta">
@@ -13,7 +19,7 @@ weight: 3
<div class="h-100 card shadow" href="#">
<div class="card-body">
<h4 class="card-title">
- <a href="https://dubbo.apache.org/cn/java-sdk/v3.x/quick-start">Quick start</a>
+ <a href="https://dubbo.apache.org/cn/java-sdk/v3.x/quick-start">参考手册</a>
</h4>
<p>Dubbo Java SDK</p>
</div>
@@ -23,16 +29,15 @@ weight: 3
<div class="h-100 card shadow">
<div class="card-body">
<h4 class="card-title">
- <a href="https://dubbo.apache.org/cn/golang-sdk/quick-start/">Quick start</a>
+ <a href="https://dubbo.apache.org/cn/golang-sdk/quick-start/">参考手册</a>
</h4>
<p>Dubbo Golang SDK</p>
</div>
</div>
</div>
-
+
</div>
<hr>
</div>
{{< /blocks/section >}}
-
diff --git a/content/cn/facade-docs/how/quick-start.md b/content/cn/facade-docs/quickstart/_index.md
old mode 100644
new mode 100755
similarity index 96%
rename from content/cn/facade-docs/how/quick-start.md
rename to content/cn/facade-docs/quickstart/_index.md
index 293f45944b..c9e47ef2d1
--- a/content/cn/facade-docs/how/quick-start.md
+++ b/content/cn/facade-docs/quickstart/_index.md
@@ -1,8 +1,9 @@
+
---
type: docs
title: "快速开始"
linkTitle: "快速开始"
-weight: 3
+weight: 2
---
{{< blocks/section color="white" height="auto">}}
@@ -29,10 +30,9 @@ weight: 3
</div>
</div>
</div>
-
+
</div>
<hr>
</div>
-{{< /blocks/section >}}
-
+{{< /blocks/section >}}
\ No newline at end of file
diff --git a/content/cn/facade-docs/tasks/_index.md b/content/cn/facade-docs/tasks/_index.md
new file mode 100755
index 0000000000..302f98ae52
--- /dev/null
+++ b/content/cn/facade-docs/tasks/_index.md
@@ -0,0 +1,11 @@
+
+---
+type: docs
+title: "示例实践"
+linkTitle: "示例实践"
+description: ""
+weight: 4
+---
+
+
+
diff --git a/content/cn/facade-docs/what/_index.md b/content/cn/facade-docs/what/_index.md
index ff210d4cba..55a409a6a6 100644
--- a/content/cn/facade-docs/what/_index.md
+++ b/content/cn/facade-docs/what/_index.md
@@ -1,7 +1,7 @@
---
type: docs
-title: "什么是Dubbo？"
-linkTitle: "什么是Dubbo？"
+title: "什么是 Dubbo"
+linkTitle: "什么是 Dubbo"
weight: 1
description: ""
---
\ No newline at end of file
diff --git a/content/cn/facade-docs/what/ecosystem.md b/content/cn/facade-docs/what/ecosystem.md
index 37255cd6cc..0a57e72b33 100644
--- a/content/cn/facade-docs/what/ecosystem.md
+++ b/content/cn/facade-docs/what/ecosystem.md
@@ -1,6 +1,6 @@
---
type: docs
-title: "生态"
+title: "Dubbo 生态"
linkTitle: "生态"
weight: 3
description: ""
diff --git a/content/cn/facade-docs/what/overview.md b/content/cn/facade-docs/what/overview.md
index 451a2d5adb..0a137edadb 100644
--- a/content/cn/facade-docs/what/overview.md
+++ b/content/cn/facade-docs/what/overview.md
@@ -1,6 +1,6 @@
---
type: docs
-title: "简介"
+title: "Dubbo 简介"
linkTitle: "简介"
weight: 1
description: ""
diff --git a/content/cn/facade-docs/whatsnew/_index.md b/content/cn/facade-docs/whatsnew/_index.md
new file mode 100755
index 0000000000..70b36d033d
--- /dev/null
+++ b/content/cn/facade-docs/whatsnew/_index.md
@@ -0,0 +1,7 @@
+
+---
+type: docs
+title: "3.0 速览"
+linkTitle: "3.0 速览"
+weight: 3
+---
diff --git a/content/cn/facade-docs/whatsnew/mesh.md b/content/cn/facade-docs/whatsnew/mesh.md
new file mode 100644
index 0000000000..7629b6acd7
--- /dev/null
+++ b/content/cn/facade-docs/whatsnew/mesh.md
@@ -0,0 +1,9 @@
+---
+type: docs
+title: "Mesh"
+linkTitle: "Mesh"
+weight: 1
+---
+
+
+
diff --git a/content/cn/facade-docs/whatsnew/servicediscovery3.md b/content/cn/facade-docs/whatsnew/servicediscovery3.md
new file mode 100644
index 0000000000..e6b300732f
--- /dev/null
+++ b/content/cn/facade-docs/whatsnew/servicediscovery3.md
@@ -0,0 +1,9 @@
+---
+type: docs
+title: "应用级服务发现"
+linkTitle: "应用级服务发现"
+weight: 2
+---
+
+
+
diff --git a/content/cn/facade-docs/whatsnew/triple.md b/content/cn/facade-docs/whatsnew/triple.md
new file mode 100644
index 0000000000..fad7f1e702
--- /dev/null
+++ b/content/cn/facade-docs/whatsnew/triple.md
@@ -0,0 +1,9 @@
+---
+type: docs
+title: "Triple 协议"
+linkTitle: "Triple 协议"
+weight: 1
+---
+
+
+
diff --git a/content/cn/facade-docs/why/_index.md b/content/cn/facade-docs/why/_index.md
deleted file mode 100755
index e8dc090b94..0000000000
--- a/content/cn/facade-docs/why/_index.md
+++ /dev/null
@@ -1,11 +0,0 @@
-
----
-type: docs
-title: "为什么使用Dubbo？"
-linkTitle: "为什么使用Dubbo？"
-description: ""
-weight: 2
----
-
-
-