diff --git a/docs-website/README.md b/docs-website/README.md index 0acbce9254..53f9ff9d98 100644 --- a/docs-website/README.md +++ b/docs-website/README.md @@ -10,17 +10,15 @@ yarn install ## Local Development -```console +```sh +# This command starts a local development server and open up a browser window. ../gradlew yarnStart -# You may also have success running the underlying commands manually. -yarn run lint -yarn run generate -yarn run start +# Every time a markdown file is changed, update the site: +# If a more complex docs site change is made, you'll need to restart the server. +../gradlew fastReload ``` -This command starts a local development server and open up a browser window. - ## Build ```console diff --git a/docs-website/build.gradle b/docs-website/build.gradle index 5fc5690d25..3ed318f2cb 100644 --- a/docs-website/build.gradle +++ b/docs-website/build.gradle @@ -77,6 +77,9 @@ task yarnGenerate(type: YarnTask, dependsOn: [yarnInstall, generateGraphQLSchema task yarnStart(type: YarnTask, dependsOn: [yarnInstall, yarnGenerate]) { args = ['run', 'start'] } +task fastReload(type: YarnTask) { + args = ['run', 'generate-rsync'] +} task yarnLint(type: YarnTask, dependsOn: [yarnInstall]) { inputs.files(projectMdFiles) diff --git a/docs-website/generateDocsDir.ts b/docs-website/generateDocsDir.ts index 3c1b888be1..044ebccc74 100644 --- a/docs-website/generateDocsDir.ts +++ b/docs-website/generateDocsDir.ts @@ -15,7 +15,7 @@ const GITHUB_EDIT_URL = const GITHUB_BROWSE_URL = "https://github.com/datahub-project/datahub/blob/master"; -const OUTPUT_DIRECTORY = "genDocs"; +const OUTPUT_DIRECTORY = "docs"; const SIDEBARS_DEF_PATH = "./sidebars.js"; const sidebars = require(SIDEBARS_DEF_PATH); diff --git a/docs-website/package.json b/docs-website/package.json index c11eb2ec69..c622f8a461 100644 --- a/docs-website/package.json +++ b/docs-website/package.json @@ -10,8 +10,10 @@ "deploy": "docusaurus deploy", "serve": "docusaurus serve", "clear": "docusaurus clear && rm -rf genDocs/*", - "generate-graphql-internal": "docusaurus docs:generate:graphql", - "generate": "rm -rf docs genDocs && mkdir docs genDocs && yarn generate-graphql-internal && ts-node -O '{ \"lib\": [\"es2020\"], \"target\": \"es6\" }' generateDocsDir.ts && mv -v docs/* genDocs/ && rmdir docs", + "_generate-graphql": "mkdir -p genDocs && docusaurus docs:generate:graphql", + "_generate-docs": "rm -rf docs && mkdir docs && yarn _generate-graphql && ts-node -O '{ \"lib\": [\"es2020\"], \"target\": \"es6\" }' generateDocsDir.ts", + "generate": "rm -rf genDocs && mkdir genDocs && yarn _generate-docs && mv docs/* genDocs/ && rmdir docs", + "generate-rsync": "mkdir -p genDocs && yarn _generate-docs && rsync -v --checksum -r -h -i --delete docs/ genDocs && rm -rf docs", "lint": "prettier -w generateDocsDir.ts sidebars.js src/pages/index.js", "lint-check": "prettier -l generateDocsDir.ts sidebars.js src/pages/index.js", "lint-fix": "prettier --write generateDocsDir.ts sidebars.js src/pages/index.js"