diff --git a/README.md b/README.md index 11438da..9e0177f 100644 --- a/README.md +++ b/README.md @@ -46,12 +46,14 @@ This command will locally build the website and documentation and merge them to yarn build ``` -Deployment is yet to be implemented. +You can check the local build with the following command: ```console -yarn deploy +npx http-server public/ ``` +After you made changes to the docs and confirmed they work locally, you can submit a pull request. Once it's merged, it will be automatically deployed by GitHub Actions. + ## Contribute Contributions are always welcome! diff --git a/package.json b/package.json index d2af9b1..e823188 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,6 @@ "build:docs": "antora antora-playbook.yml", "watch:build:docs": "bash -c 'while inotifywait -q -e create,modify,delete -r modules/ROOT/pages/; do echo yarn build:docs; yarn build:docs; done'", "clean": "gatsby clean && rm -r build", - "typecheck": "tsc --noEmit", "format": "prettier --write .", "deploy:netlify": "netlify deploy --prod --dir public/ --site hawtio-v3" },