Fix site (documentation) generation #3143
Merged
Conversation
This file contains hidden or 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
1) Fix googleapis#3084. Now create_site.sh takes 2 min 50 sec on my workstation (compared to arond 1 hr 30 min before). Done mostly by disabling unused/incorrect reports generation. 2) Remove unused/incorrect reports (reduces size of generated site by factor of 2). The most time consuming were the `cobertura test coverage`, `code style` and `dependencies` reports: 2.1) For cobertura test coverage, since we were generating tests with -DdisableTests flag, the test coverage is constantly reported as 0 with huge reports full of zeros and "red" untested code: https://googlecloudplatform.github.io/google-cloud-java/0.42.1/cobertura/index.html 2.2) For `code style`: it was far the most time consuming report, results of which are huge and which we ignore and they seem have no real value: https://googlecloudplatform.github.io/google-cloud-java/0.42.1/checkstyle-aggregate.html 2.3) Dependencies report has marginal use, and is the only one I removed not because it was wrong, but was almos useless, but was the second most time consuming report among all (after the code style). 2) Fix google-cloud-bom documentation discrepancies (looked completely differently, needed extra configuration, since it is not a child of the main pom) 3) Fix site multimodule cross links (currently https://googlecloudplatform.github.io/google-cloud-java/0.42.1/modules.html is completely broken, for example try clicking on `Google Cloud Java BOM`, `Google Cloud Dataproc` and `Google Cloud Datastore` - all give different results and only dataproc kind of works). 4) More changes will be done in the context of moving grpc and proto artifacts under google-cloud-java (our maven plugins need update and currently we use deprecated (unsupported in newer versions) configuration.
googlebot
added
the
cla: yes
garrettjonesgoogle
approved these changes
Apr 10, 2018
Member
garrettjonesgoogle
left a comment
garrettjonesgoogle
left a comment
There was a problem hiding this comment.
LGTM after copyright fix
google-cloud-bom/src/site/site.xml
Outdated
| @@ -0,0 +1,32 @@ | |||
| <!-- | |||
| ~ Copyright 2018 Google Inc. All Rights Reserved. | |||
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Fix javadoc takes a long time to generate #3084. Now
create_site.shtakes2 min 50 secon my workstation (compared to around1 hr 30 minbefore). Done mostly by disabling unused/incorrect reports generation.Remove unused/incorrect reports (reduces size of generated site by factor of 2). The most time consuming were the cobertura test coverage, code style and dependencies reports:
2.1) For cobertura test coverage, since we were generating the report with
-DdisableTestsflag, the test coverage was constantly reported as 0 with huge reports full of zeros and "red" untested code: https://googlecloudplatform.github.io/google-cloud-java/0.42.1/cobertura/index.html2.2) For code style: it was far the most time consuming report, results of which are huge and which we ignore and they seem have no real value in our workflow (if it did, we should enforce that rules on build and fix them, instead of generating reports): https://googlecloudplatform.github.io/google-cloud-java/0.42.1/checkstyle-aggregate.html
2.3) Dependencies report has marginal use, and is the only one I removed not because it was wrong, but was almos useless, but was the second most time consuming report among all (after the code style).
Fix
google-cloud-bomdocumentation discrepancies (looked completely differently, needed extra configuration, since it is not a child of the main pom)Fix site multimodule cross links (currently https://googlecloudplatform.github.io/google-cloud-java/0.42.1/modules.html is completely broken, for example try clicking on
Google Cloud Java BOM,Google Cloud DataprocandGoogle Cloud Datastore- all give different results and only dataproc kind of works).More changes will be done in the context of moving grpc and proto artifacts under google-cloud-java (our maven plugins need update and currently we use deprecated (unsupported in newer versions) configuration.