Browse Source

[doc] change document structure (#10124)

This patch change the structure and make it more sense

* Remove dev doc in tab Docs, and for now you could only see it in
  history-version page
* Move PyDolphinScheduler from tab DOCS to sidebar and combine with open
  API
* Move installation after Functions
* Move data quality after HOW-TOS
3.1.0-release
Jiajie Zhong 3 years ago committed by GitHub
parent
commit
2eff5ee10c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 128
      docs/configs/docsdev.js
  2. 10
      docs/configs/site.js

128
docs/configs/docsdev.js

@ -50,27 +50,6 @@ export default {
}, },
], ],
}, },
{
title: 'Installation',
children: [
{
title: 'Standalone Deployment',
link: '/en-us/docs/dev/user_doc/guide/installation/standalone.html',
},
{
title: 'Pseudo Cluster Deployment',
link: '/en-us/docs/dev/user_doc/guide/installation/pseudo-cluster.html',
},
{
title: 'Cluster Deployment',
link: '/en-us/docs/dev/user_doc/guide/installation/cluster.html',
},
{
title: 'Kubernetes Deployment',
link: '/en-us/docs/dev/user_doc/guide/installation/kubernetes.html',
},
],
},
{ {
title: 'Introduction to Functions', title: 'Introduction to Functions',
children: [ children: [
@ -267,10 +246,6 @@ export default {
}, },
], ],
}, },
{
title: 'Data Quality',
link: '/en-us/docs/dev/user_doc/guide/data-quality.html',
},
{ {
title: 'Resource', title: 'Resource',
children: [ children: [
@ -310,8 +285,8 @@ export default {
], ],
}, },
{ {
title: 'Open API', title: 'Data Quality',
link: '/en-us/docs/dev/user_doc/guide/open-api.html', link: '/en-us/docs/dev/user_doc/guide/data-quality.html',
}, },
{ {
title: 'Flink', title: 'Flink',
@ -327,6 +302,27 @@ export default {
}, },
], ],
}, },
{
title: 'Installation',
children: [
{
title: 'Standalone Deployment',
link: '/en-us/docs/dev/user_doc/guide/installation/standalone.html',
},
{
title: 'Pseudo Cluster Deployment',
link: '/en-us/docs/dev/user_doc/guide/installation/pseudo-cluster.html',
},
{
title: 'Cluster Deployment',
link: '/en-us/docs/dev/user_doc/guide/installation/cluster.html',
},
{
title: 'Kubernetes Deployment',
link: '/en-us/docs/dev/user_doc/guide/installation/kubernetes.html',
},
],
},
{ {
title: 'Architecture Guide', title: 'Architecture Guide',
children: [ children: [
@ -356,6 +352,19 @@ export default {
}, },
], ],
}, },
{
title: 'API',
children: [
{
title: 'Open API',
link: '/en-us/docs/dev/user_doc/guide/open-api.html',
},
{
title: 'PyDolphinScheduler',
link: '/python/index.html',
},
],
},
{ {
title: 'FAQ', title: 'FAQ',
children: [ children: [
@ -409,27 +418,6 @@ export default {
}, },
], ],
}, },
{
title: '部署指南',
children: [
{
title: '单机部署(Standalone)',
link: '/zh-cn/docs/dev/user_doc/guide/installation/standalone.html',
},
{
title: '伪集群部署(Pseudo-Cluster)',
link: '/zh-cn/docs/dev/user_doc/guide/installation/pseudo-cluster.html',
},
{
title: '集群部署(Cluster)',
link: '/zh-cn/docs/dev/user_doc/guide/installation/cluster.html',
},
{
title: 'Kubernetes部署(Kubernetes)',
link: '/zh-cn/docs/dev/user_doc/guide/installation/kubernetes.html',
},
],
},
{ {
title: '功能介绍', title: '功能介绍',
children: [ children: [
@ -626,10 +614,6 @@ export default {
}, },
], ],
}, },
{
title: '数据质量',
link: '/zh-cn/docs/dev/user_doc/guide/data-quality.html',
},
{ {
title: '资源中心', title: '资源中心',
children: [ children: [
@ -660,7 +644,7 @@ export default {
link: '/zh-cn/docs/dev/user_doc/guide/security.html', link: '/zh-cn/docs/dev/user_doc/guide/security.html',
}, },
{ {
title: '见操作', title: '用指引',
children: [ children: [
{ {
title: '通用设置', title: '通用设置',
@ -669,8 +653,8 @@ export default {
], ],
}, },
{ {
title: 'API调用', title: '数据质量',
link: '/zh-cn/docs/dev/user_doc/guide/open-api.html', link: '/zh-cn/docs/dev/user_doc/guide/data-quality.html',
}, },
{ {
title: 'Flink调用', title: 'Flink调用',
@ -686,6 +670,27 @@ export default {
}, },
], ],
}, },
{
title: '部署指南',
children: [
{
title: '单机部署(Standalone)',
link: '/zh-cn/docs/dev/user_doc/guide/installation/standalone.html',
},
{
title: '伪集群部署(Pseudo-Cluster)',
link: '/zh-cn/docs/dev/user_doc/guide/installation/pseudo-cluster.html',
},
{
title: '集群部署(Cluster)',
link: '/zh-cn/docs/dev/user_doc/guide/installation/cluster.html',
},
{
title: 'Kubernetes部署(Kubernetes)',
link: '/zh-cn/docs/dev/user_doc/guide/installation/kubernetes.html',
},
],
},
{ {
title: '架构设计', title: '架构设计',
children: [ children: [
@ -715,6 +720,19 @@ export default {
}, },
], ],
}, },
{
title: 'API',
children: [
{
title: 'API调用',
link: '/zh-cn/docs/dev/user_doc/guide/open-api.html',
},
{
title: 'PyDolphinScheduler',
link: '/python/index.html',
},
],
},
{ {
title: 'FAQ', title: 'FAQ',
children: [ children: [

10
docs/configs/site.js

@ -58,16 +58,6 @@ export default {
text: 'Older Versions', text: 'Older Versions',
link: '/en-us/docs/release/history-versions.html', link: '/en-us/docs/release/history-versions.html',
}, },
{
key: 'pythonAPI',
text: 'PyDolphinScheduler',
link: '/python/index.html',
},
{
key: 'docsdev',
text: 'dev',
link: '/en-us/docs/dev/user_doc/about/introduction.html',
},
], ],
}, },
{ {

Loading…
Cancel
Save