Adalennis opened a new pull request, #8905: URL: https://github.com/apache/hop/pull/8905
Fixes #2605 The "Writing documentation" page in the developer manual listed "Building the documentation locally to preview it" as still to write. This adds a "Previewing the documentation locally" section: - Where to check out apache/hop-website (next to the Hop checkout, which must be in a folder named `hop`, because the playbook reads `../hop`). - The same steps the pull request build runs: `npm ci`, the three `tools/sync-*.mjs` scripts, and `antora` with `antora-playbook-hop.yml`, plus `npm run serve`. - The differences with the website that are easy to trip over: pages are under `latest` instead of `next`, the navigation does not expand without copying `static/js`, and deleted pages stay in `public/` until it is emptied. - Linked the website's Documentation Contribution Guide from the page introduction, for the fork and pull request steps. - [x] Run `mvn clean install apache-rat:check` to make sure basic checks pass. A more thorough check will be performed on your pull request automatically. - [x] If you have a group of commits related to the same change, please squash your commits into one and force push your branch using `git rebase -i`. - [x] Mention the appropriate issue in your description (for example: `addresses #123`), if applicable. To make clear that you license your contribution under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0) you have to acknowledge this by using the following check-box. - [x] I hereby declare this contribution to be licensed under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0) - [ ] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf). -- 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. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
