This is an automated email from the ASF dual-hosted git repository.
gallardot pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-website.git
The following commit(s) were added to refs/heads/master by this push:
new d386be727e [Doc] Some improvements (#965)
d386be727e is described below
commit d386be727e881beafb1793ecf44255f8d86f82ae
Author: xiangzihao <[email protected]>
AuthorDate: Thu Sep 26 17:59:08 2024 +0800
[Doc] Some improvements (#965)
* Fix typos
* Add directory of local debug in gitignore
* Add build-website-deploy to mergeable check
---------
Co-authored-by: sbloodys <[email protected]>
---
.asf.yaml | 1 +
.gitignore | 4 ++++
HOW_PREPARE_WOKR.md => HOW_PREPARE_WORK.md | 0
README.md | 7 +------
scripts/generate_docs.js | 22 +++++++++++-----------
5 files changed, 17 insertions(+), 17 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 1e5e196030..56ad5b038d 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -41,6 +41,7 @@ github:
required_status_checks:
contexts:
- CheckDeadLinks
+ - build-website-deploy
required_pull_request_reviews:
dismiss_stale_reviews: true
required_approving_review_count: 1
diff --git a/.gitignore b/.gitignore
index c19d8d3340..c1b6f254d8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -26,6 +26,8 @@ config/docs*.js
config/site.js
swap/
+img/
+en-us/
docs/
public/data
public/img
@@ -36,3 +38,5 @@ public/.asf.yaml
public/LICENSE
*.icloud
.idea
+
+package-lock.json
diff --git a/HOW_PREPARE_WOKR.md b/HOW_PREPARE_WORK.md
similarity index 100%
rename from HOW_PREPARE_WOKR.md
rename to HOW_PREPARE_WORK.md
diff --git a/README.md b/README.md
index 7b3b27d9b4..e7f2ffa95f 100644
--- a/README.md
+++ b/README.md
@@ -2,17 +2,12 @@
This project keeps all sources used for building up DolphinScheduler's
official website which is served at https://dolphinscheduler.apache.org/.
-## Prerequisite
-
-DolphinScheduler website is powered by
[docsite](https://github.com/chengshiwen/docsite-ext). Please also make sure
your
-node version is 10+, version lower than 10.x is not supported yet.
-
## Build Website Locally
1. Run `yarn` in the root directory to install the dependencies.
2. Run commands to collect resources
2.1. Run `export PROTOCOL_MODE=ssh` tells Git clone resource via SSH
protocol instead of HTTPS protocol
- 2.2. Run `./scripts/prepare_docs.sh` prepare all related resources, for
more information you could see [how prepare script work](HOW_PREPARE_WOKR.md)
+ 2.2. Run `./scripts/prepare_docs.sh` prepare all related resources, for
more information you could see [how prepare script work](HOW_PREPARE_WORK.md)
3. Run `yarn generate` in the root directory to format and perpare the data.
4. Run `yarn dev` in the root directory to start a local server, you will see
the website in 'http://localhost:8080'.
diff --git a/scripts/generate_docs.js b/scripts/generate_docs.js
index 5129afdf32..3eb91d63d0 100644
--- a/scripts/generate_docs.js
+++ b/scripts/generate_docs.js
@@ -180,7 +180,7 @@ const getMenu = (list, data, version, lang, isDeployment,
location) => {
});
};
-const wirteFileByLang = (data, lang, fileName) => {
+const writeFileByLang = (data, lang, fileName) => {
const targetPath = `${BASE}/public/fetch/doc/${lang}`;
fs.ensureDirSync(targetPath);
fs.writeFileSync(
@@ -189,7 +189,7 @@ const wirteFileByLang = (data, lang, fileName) => {
);
};
-const wirteDeployment = () => {
+const writeDeployment = () => {
const targetDataPath = `${BASE}/public/fetch`;
fs.ensureDirSync(targetDataPath);
fs.writeFileSync(
@@ -198,7 +198,7 @@ const wirteDeployment = () => {
);
};
-const wirteDownload = () => {
+const writeDownload = () => {
const targetDataPath = `${BASE}/public/fetch`;
fs.ensureDirSync(targetDataPath);
fs.writeFileSync(
@@ -207,7 +207,7 @@ const wirteDownload = () => {
);
};
-const wirteVersion = () => {
+const writeVersion = () => {
fs.ensureDirSync(`${BASE}/public/fetch`);
fs.writeFileSync(
`${BASE}/public/fetch/version.json`,
@@ -215,7 +215,7 @@ const wirteVersion = () => {
);
};
-const wirteSearchDocData = () => {
+const writeSearchDocData = () => {
["en-us", "zh-cn"].forEach((lang) => {
const targetSearchPath = `${BASE}/public/data/doc/${lang}.json`;
fs.ensureFileSync(targetSearchPath);
@@ -284,13 +284,13 @@ const parseDocsMenu = () => {
versionData.push(version);
- wirteFileByLang(enUs, "en-us", fileInfo.name);
- wirteFileByLang(zhCn, "zh-cn", fileInfo.name);
+ writeFileByLang(enUs, "en-us", fileInfo.name);
+ writeFileByLang(zhCn, "zh-cn", fileInfo.name);
});
- wirteSearchDocData();
- wirteDeployment();
- wirteDownload();
- wirteVersion();
+ writeSearchDocData();
+ writeDeployment();
+ writeDownload();
+ writeVersion();
};
module.exports = parseDocsMenu;
