docs: host javadocs on GH #3377
Merged
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
mo-auto
added
area-CI
moabu
requested changes
Dec 21, 2022
ossdhaval
commented
Dec 22, 2022
ossdhaval
commented
Dec 22, 2022
moabu
reviewed
Dec 28, 2022
moabu
requested changes
Dec 28, 2022
moabu
requested changes
Jan 2, 2023
automation/docs/generate-javadocs.sh
Outdated
| echo "Move generated javadocs to respective doc site location" | ||
|
|
||
| echo "getting locations where javadocs got generated" | ||
| generated_doc_paths=($(find "$module" -type d -path '*/target/site/apidocs' | sed -r 's|/[^/]+$||' | sed -r 's|/[^/]+$||' | sed -r 's|/[^/]+$||')) |
There was a problem hiding this comment.
This is problematic. You should probably use mapfile since this returns multiple lines.
Something like:
mapfile -t generated_doc_paths < <(find "$module" -type d -path '*/target/site/apidocs' | sed -r 's|/[^/]+$||' | sed -r 's|/[^/]+$||' | sed -r 's|/[^/]+$||')
This should help:
https://github.com/koalaman/shellcheck/wiki/SC2207
Adjust and test please.
moabu
approved these changes
Jan 4, 2023
This was referenced Apr 24, 2023
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.
Prepare
Description
In order to version javadocs generated by each module, it was decided to host them in GH repo. This PR will generate javadocs for all the modules and move them to respective locations under
jans/docs/admin/reference/javadoc/<module>.A subsequent CR will process them further and publish them on MKDocs site as discussed with Mo.
Target issue
closes #issue-number-here
Implementation Details
Test and Document the changes