tobous commented on a change in pull request #14: URL: https://github.com/apache/db-jdo-site/pull/14#discussion_r557339854
########## File path: README.md ########## @@ -39,8 +39,22 @@ Contributions to this repository follow the default [GitHub workflow](https://gu To contribute changes, you can follow these steps: * Adapt the AsciiDoc files in `src/main/asciidoc` or the website menu in `src/main/template`. - * Call `mvn clean compile` to build the site and verify the generated website by viewing it locally with a web browser. + * Call `mvn clean install` to build the site and verify the generated website by viewing `target/index.html` locally with a web browser. * Commit the source changes (not the build artifacts) and open a pull request. ### TODO * If you find any issues please provide a PR or [create a JIRA ticket](https://issues.apache.org/jira/projects/JDO/issues/?filter=allopenissues) + +### PUBLISHING THE SITE +After changes have been made to the sources in the `db-jdo-site/src/main/asciidoc` or `db-jdo-site/src/main/template` directory, changes will be published automatically to the live web site by simply pushing changes to the master branch of the repository. The process is as follows: + +1. Pushing changes to the master branch invokes the post-push script in `db-jdo-site/.github/workflows/deploy-site.yml` which builds the site in `db-jdo-site/target/` via `mvn clean install`. Review comment: How about adding a static link to the workflow file? ```suggestion 1. Pushing changes to the master branch invokes the post-push script in [`db-jdo-site/.github/workflows/deploy-site.yml`](.github/workflows/deploy-site.yml) which builds the site in `db-jdo-site/target/` via `mvn clean install`. ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org
