This is an automated email from the ASF dual-hosted git repository.
benjobs pushed a commit to branch dev
in repository
https://gitbox.apache.org/repos/asf/incubator-streampark-website.git
The following commit(s) were added to refs/heads/dev by this push:
new 16b881d6 [Issue-2216][Feature] Support external link (#201)
16b881d6 is described below
commit 16b881d610ab311daaccb3f0f66408ddd217a5a8
Author: Leomax_Sun <[email protected]>
AuthorDate: Mon May 8 22:22:36 2023 +0800
[Issue-2216][Feature] Support external link (#201)
---
docs/user-guide/9-ExternalLink.md | 22 +++++++++++++++++++
.../current/user-guide/9-externalLink.md | 24 +++++++++++++++++++++
static/doc/image/external-link/badge.png | Bin 0 -> 316841 bytes
.../image/external-link/external-link-detail.png | Bin 0 -> 66605 bytes
4 files changed, 46 insertions(+)
diff --git a/docs/user-guide/9-ExternalLink.md
b/docs/user-guide/9-ExternalLink.md
new file mode 100644
index 00000000..58585f4d
--- /dev/null
+++ b/docs/user-guide/9-ExternalLink.md
@@ -0,0 +1,22 @@
+---
+id: 'ExternalLink'
+title: 'External Link Management'
+sidebar_position: 9
+---
+
+## Background
+In production practice, in order to manage the Flink job properly, there is
always a need to integrate it with external services, such as code repository,
metrics monitoring page, real time logging, or checkpoint/savepoint folder on
HDFS/OSS, etc.
+
+Streampark, as an one-stop Flink DevOps platform, will bring more values to
user, if it can provide the capability of integrating those services in form of
dynamic link, which can be defined in centeralised place, and applied to each
Flink job automatically.
+
+## How to create the external link
+Login as system admin, go to the `Settings` module, and click the `External
Link` from the navigation bar. From the listing page, you are able to click the
`Add New` button and create new entry.
+
+<img src="/doc/image/external-link/external-link-detail.png"/><br></br>
+
+In the detail page, each link consists of label(optional), name, color and
link. And they can make a clickable badge together. Color can be either chosen
from the `color picker`, or just click the samples on the right side to follow
the pattern, and after that you can preview the badge immediately. And last but
not least, the link can be definded with placeholder, including `job_id`,
`job_name` and `yarn_id`, all of that can be replaced with real values, and
become a clickable badge when [...]
+
+## Where can see the external link
+After the Flink job starts, you can go to the `Application` module, and click
the Flink job from the list page. After that, all the defined badges will be
displayed on the top of the detail page, and upon click, request will be
redirected to desired external service page.
+
+<img src="/doc/image/external-link/badge.png"/><br></br>
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/9-externalLink.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/9-externalLink.md
new file mode 100644
index 00000000..1f4c361e
--- /dev/null
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/user-guide/9-externalLink.md
@@ -0,0 +1,24 @@
+---
+id: 'ExternalLink'
+title: '扩展链接'
+sidebar_position: 9
+---
+
+## 背景介绍
+在生产实践中，为了更好地管理 Flink作业，总会需要将其与外部服务集成，例如代码仓库、指标监控页面、实时日志记录或 HDFS/OSS
上的检查点/保存点文件夹等。
+
+Streampark 作为一站式 Flink DevOps 平台，如果能够提供以扩展链接的形式集成这些服务的能力，在统一的地方集中定义，并自动应用于每个
Flink 作业，将为用户带来更多价值。
+
+
+## 如何创建扩展链接
+以系统管理员身份登录，进入`设置`模块，然后点击导航栏中的`外部链接`。从列表页面，您可以单击新增按钮并创建新条目。
+
+<img src="/doc/image/external-link/external-link-detail.png"/><br></br>
+
+在新增详情页中，每个扩展链接由标签（可选）、名称、颜色和链接组成，他们共同组成一个可点击的图标。颜色可以从`颜色选择器`中选择，或者只需单击右侧的样例，从而采用相同的样式，然后您可以立即预览图标。最后但同样重要的是，在扩展链接中可以使用占位符定义，包括
`job_id`、`job_name` 和 `yarn_id`。当Flink作业启动后，所有这些占位符都会被替换为实际值，并成为可点击的图标。
+
+## 扩展链接的使用
+Flink 作业启动后，您可以进入 `Application` 模块，在列表页面中点击 Flink
作业。进入详情页后，所有定义的拓展链接将显示在详细信息页面的顶部，点击后即可跳转到期望的外部服务页面。
+
+<img src="/doc/image/external-link/badge.png"/><br></br>
+
diff --git a/static/doc/image/external-link/badge.png
b/static/doc/image/external-link/badge.png
new file mode 100644
index 00000000..7c066500
Binary files /dev/null and b/static/doc/image/external-link/badge.png differ
diff --git a/static/doc/image/external-link/external-link-detail.png
b/static/doc/image/external-link/external-link-detail.png
new file mode 100644
index 00000000..871a4e68
Binary files /dev/null and
b/static/doc/image/external-link/external-link-detail.png differ
