Skip to content

Commit

Permalink
fix: 修改文档路径前缀 (#891)
Browse files Browse the repository at this point in the history
  • Loading branch information
jiayuan929 authored Nov 15, 2023
1 parent 356bcd7 commit e751bc1
Show file tree
Hide file tree
Showing 52 changed files with 72 additions and 72 deletions.
36 changes: 18 additions & 18 deletions apiserver/paasng/fixtures/smart_advisor.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
title_en: "Guide to building a local Python development environment",
short_description_zh_cn: '',
short_description_en: '',
location: '{doc_url_prefix}/markdown/PaaS3.0/topics/company_tencent/python_framework_usage#python',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/topics/company_tencent/python_framework_usage#python',
affinity_tags: '["app-pl:python","plat-panel:app_created"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -13,7 +13,7 @@
title_en: How to deploy the BlueKing app",
short_description_zh_cn: '',
short_description_en: '',
location: '{doc_url_prefix}/markdown/PaaS3.0/topics/paas/deploy_intro',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/deploy_intro',
affinity_tags: '["plat-panel:app_created"]', anti_affinity_tags: '[]', priority: 1,
created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -22,7 +22,7 @@
title_en: "Introduction to app process concepts and how to use",
short_description_zh_cn: "关于应用进程的简单介绍,内容包含 Procfile",
short_description_en: "A brief description of the app process, including the Procfile",
location: '{doc_url_prefix}/markdown/PaaS3.0/topics/paas/process_procfile#section',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/process_procfile#section',
affinity_tags: '["plat-panel:app_deployment","plat-panel:app_processes", "deploy_phase:prepare"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -31,7 +31,7 @@
title_en: "Guidelines for process communication in app",
short_description_zh_cn: "",
short_description_en: "",
location: "{doc_url_prefix}/markdown/PaaS3.0/topics/paas/entry_proc_services#进程间如何通信",
location: "{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/entry_proc_services#进程间如何通信",
affinity_tags: '["plat-panel:app_deployment","plat-panel:app_processes"]',
anti_affinity_tags: '[]', priority: 1, created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -40,7 +40,7 @@
title_en: "Example: How to add a celery backend task to a Python app",
short_description_zh_cn: "",
short_description_en: "",
location: "{doc_url_prefix}/markdown/PaaS3.0/topics/paas/process_procfile#什么是procfile",
location: "{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/process_procfile#什么是procfile",
affinity_tags: '["app-pl:python","plat-panel:app_deployment","plat-panel:app_processes", "deploy_phase:prepare"]',
anti_affinity_tags: '[]', priority: 1, created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -49,7 +49,7 @@
title_en: "Quick start: developing apps in Go",
short_description_zh_cn: "",
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/quickstart/golang/golang_preparations',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/quickstart/golang/golang_preparations',
affinity_tags: '["app-pl:go","plat-panel:app_deployment","plat-panel:app_created"]',
anti_affinity_tags: '[]', priority: 1, created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -58,7 +58,7 @@
title_en: "Fix Procfile related errors",
short_description_zh_cn: "",
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/faq/deploy#修复%20Procfile%20报错(fix-procfile)',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/faq/deploy#修复%20Procfile%20报错(fix-procfile)',
affinity_tags: '["deploy-failure:fix-procfile"]', anti_affinity_tags: '[]', priority: 1,
created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -67,7 +67,7 @@
title_en: "Fix Python MySQL installation error",
short_description_zh_cn: "",
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/faq/deploy#修复%20python%20mysql%20模块安装时报错(fix-pkg-install-mysql-python)',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/faq/deploy#修复%20python%20mysql%20模块安装时报错(fix-pkg-install-mysql-python)',
affinity_tags: '["deploy-failure:fix-pkg-install-mysql-python"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -76,7 +76,7 @@
title_en: "App cannot start building",
short_description_zh_cn: '',
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/faq/deploy#应用无法开始构建(fix-unable-select-buildpack)',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/faq/deploy#应用无法开始构建(fix-unable-select-buildpack)',
affinity_tags: '["deploy-failure:fix-unable-select-buildpack"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -85,7 +85,7 @@
title_en: "Fix collectstatic phase error",
short_description_zh_cn: "",
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/faq/deploy#修复 collectstatic 阶段报错(fix-py-collect-static)',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/faq/deploy#修复 collectstatic 阶段报错(fix-py-collect-static)',
affinity_tags: '["deploy-failure:fix-py-collect-static"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -94,7 +94,7 @@
title_en: "Fix Python app runtime errors",
short_description_zh_cn: "",
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/faq/deploy#修复 Python 应用 runtime 报错问题(fix-py-runtime-error)',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/faq/deploy#修复 Python 应用 runtime 报错问题(fix-py-runtime-error)',
affinity_tags: '["deploy-failure:fix-py-runtime-error"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -103,7 +103,7 @@
title_en: "Fixing deployment taking too long",
short_description_zh_cn: "",
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/faq/deploy#部署发布阶段耗时过长(fix-release-polling-timeout)',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/faq/deploy#部署发布阶段耗时过长(fix-release-polling-timeout)',
affinity_tags: '["deploy-failure:fix-release-polling-timeout"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2020-08-20 11:08:51+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -112,7 +112,7 @@
title_en: "Python cannot install packages with . in the package name",
short_description_zh_cn: "",
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/faq/deploy#Python 无法安装带.的包',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/faq/deploy#Python 无法安装带.的包',
affinity_tags: '["deploy-failure:fix-python-package-with-dot"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2020-09-23 04:09:18+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -121,7 +121,7 @@
title_en: "How to use the pre-release command",
short_description_zh_cn: "",
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/topics/paas/release_hooks',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/release_hooks',
affinity_tags: '["deploy_phase:build"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2020-09-23 04:09:18+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -130,7 +130,7 @@
title_en: "Configure BlueKing app access entry",
short_description_zh_cn: "",
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/topics/paas/app_entry_intro',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/app_entry_intro',
affinity_tags: '["deploy_phase:release"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2020-09-23 04:09:18+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -139,7 +139,7 @@
title_en: "Python installs dependencies with missing setuptools_rust module",
short_description_zh_cn: "",
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/faq/deploy#Python 安装依赖时提示缺少 setuptools_rust 模块',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/faq/deploy#Python 安装依赖时提示缺少 setuptools_rust 模块',
affinity_tags: '["deploy-failure:fix-pip-setuptools-rust"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2021-06-01 04:09:18+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -148,7 +148,7 @@
title_en: "npm install dependencies prompted no matching version found",
short_description_zh_cn: "",
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/faq/frame_node#npm安装依赖包提示找不到匹配的版本',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/faq/frame_node#npm安装依赖包提示找不到匹配的版本',
affinity_tags: '["deploy-failure:fix-npm-no-match-version"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2021-06-01 04:09:18+00:00' }
- model: smart_advisor.documentarylink
Expand All @@ -157,7 +157,7 @@
title_en: "Why are some processes unable to use WebConsole?",
short_description_zh_cn: '因应用"环境配置"未满足要求,控制台功能无法启动,请参考文档,修改应用配置后重试。',
short_description_en: "",
location: '{doc_url_prefix}/markdown/PaaS3.0/faq/platform#为什么有的进程无法使用访问控制台功能',
location: '{doc_url_prefix}/markdown/PaaS/DevelopTools/BaseGuide/faq/platform#为什么有的进程无法使用访问控制台功能',
affinity_tags: '["app-feature:web-console"]', anti_affinity_tags: '[]',
priority: 1, created: !!timestamp '2021-08-31 00:00:00+00:00' }
- model: smart_advisor.deployfailurepattern
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -380,10 +380,10 @@
this.dialog.form.redirect_uri = bkPaaSUrl + "/backend/api/oauth/complete/github"
this.dialog.form.token_base_url = "https://github.com/login/oauth/access_token"
this.dialog.form.oauth_display_info_zh_cn = {
"auth_docs": bkDocsUrlPrefix + "/markdown/PaaS3.0/topics/paas/github_oauth"
"auth_docs": bkDocsUrlPrefix + "/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/github_oauth"
}
this.dialog.form.oauth_display_info_en = {
"auth_docs": bkDocsUrlPrefix + "/markdown/PaaS3.0/topics/paas/github_oauth"
"auth_docs": bkDocsUrlPrefix + "/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/github_oauth"
}
} else if (kind === "gitee") {
this.dialog.form.name = "gitee"
Expand All @@ -399,10 +399,10 @@
this.dialog.form.redirect_uri = bkPaaSUrl + "/backend/api/oauth/complete/gitee"
this.dialog.form.token_base_url = "https://gitee.com/oauth/token"
this.dialog.form.oauth_display_info_zh_cn = {
"auth_docs": bkDocsUrlPrefix + "/markdown/PaaS3.0/topics/paas/gitee_oauth"
"auth_docs": bkDocsUrlPrefix + "/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/gitee_oauth"
}
this.dialog.form.oauth_display_info_en = {
"auth_docs": bkDocsUrlPrefix + "/markdown/PaaS3.0/topics/paas/gitee_oauth"
"auth_docs": bkDocsUrlPrefix + "/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/gitee_oauth"
}
}
},
Expand Down
2 changes: 1 addition & 1 deletion apiserver/paasng/paasng/settings/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -1117,7 +1117,7 @@
BK_DOCS_URL_PREFIX = settings.get('BK_DOCS_URL_PREFIX', 'https://bk.tencent.com/docs')

# 平台FAQ 地址
PLATFORM_FAQ_URL = settings.get('PLATFORM_FAQ_URL', f'{BK_DOCS_URL_PREFIX}/markdown/PaaS3.0/faq')
PLATFORM_FAQ_URL = settings.get('PLATFORM_FAQ_URL', f'{BK_DOCS_URL_PREFIX}/markdown/PaaS/DevelopTools/BaseGuide/faq')

# 是否有人工客服
SUPPORT_LIVE_AGENT = settings.get('SUPPORT_LIVE_AGENT', False)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ res = requests.post(url, headers=headers, json=data)
assert res.status_code == 201
```
#### Get your access_token
Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS3.0/topics/paas/access_token)
Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/access_token)

### Response Result Example
```json
Expand Down
2 changes: 1 addition & 1 deletion apiserver/paasng/support-files/apigw/api_doc/en/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ None.

#### Get your access_token

Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS3.0/topics/paas/access_token)
Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/access_token)


#### gitlab
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Deploy cloud-native applications.

#### Get your access_token

Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS3.0/topics/paas/access_token)
Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/access_token)

### Response Result Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ App deployment interface for deploying applications to a specified environment.
### Request Example

#### Get your access_token
Before calling the interface, please obtain your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS3.0/topics/paas/access_token)
Before calling the interface, please obtain your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/access_token)

#### gitlab

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ curl -X POST -H 'X-BKAPI-AUTHORIZATION: {"access_token": "{{Fill in your AccessT

#### Get your access_token

Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS3.0/topics/paas/access_token)
Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/access_token)


### Response Result Example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ curl -X GET -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app

#### Get your access_token

Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS3.0/topics/paas/access_token)
Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/access_token)

### Response Result Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ curl -X GET -H 'X-Bkapi-Authorization: {"bk_app_code": "apigw-api-test", "bk_app

#### Get your access_token

Before calling the interface, please obtain your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS3.0/topics/paas/access_token)
Before calling the interface, please obtain your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/access_token)

### Response Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ curl -X GET -H 'X-BKAPI-AUTHORIZATION: {"access_token": "your_access_token"}' ht

#### Get your access_token

Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS3.0/topics/paas/access_token)
Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/access_token)

### Response Result Example
```json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ curl -X GET -H 'X-BKAPI-AUTHORIZATION: {"access_token": "your_access_token"}' h

#### Get your access_token

Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS3.0/topics/paas/access_token)
Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/access_token)

### Response Result Example
```json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ curl -X GET -H 'X-BKAPI-AUTHORIZATION: {"access_token": "your_access_token"}' ht
```

#### Get your access_token
Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS3.0/topics/paas/access_token)
Before calling the interface, please get your access_token first. For specific guidance, please refer to [Using access_token to access PaaS V3](https://bk.tencent.com/docs/markdown/PaaS/DevelopTools/BaseGuide/topics/paas/access_token)

### Response Result Example
```json
Expand Down
Loading

0 comments on commit e751bc1

Please sign in to comment.