Create a script to build jakartaee docs locally #27
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kito99
requested changes
Oct 18, 2024
|
|
||
| - Navigates back to the `jakartaee-documentation` repository after building the UI. | ||
|
|
||
| 3. Copy the Antora Playbook: |
There was a problem hiding this comment.
Steps 3 and 4 should only happen if local-antora-playbook.yml doesn't already exist. Otherwise the script may overwrite local changes.
|
|
||
| 1. Build `jakartaee-documentation-ui:` | ||
|
|
||
| - Navigates to the `jakartaee-documentation-ui` repository and builds the UI using gulp bundle. |
| `jakartaee-documentation` repositories are cloned in the same parent | ||
| directory. | ||
|
|
||
| 3. Make the script executable by running. |
There was a problem hiding this comment.
For me, the script was already executable.
| 4. Run the script from the terminal or command line: | ||
|
|
||
| ```bash | ||
| ./build-and-run.sh |
kito99
requested changes
Oct 18, 2024
| # Step 1: Navigate to the jakartaee-documentation-ui repository and build it | ||
| echo "Navigating to jakartaee-documentation-ui and building..." | ||
| cd ../jakartaee-documentation-ui || { echo "Error: jakartaee-documentation-ui directory not found."; exit 1; } | ||
| gulp bundle |
There was a problem hiding this comment.
You need to add nvm use here. Otherwise if they have a different version of Node setup, it may fail (it did for me).
|
@Ndacyayisenga-droid , Bauke made good points about this staying in this repo, so let's leave it here and perhaps update it to work for the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cc @kito99