Skip to content

Conversation

@chingor13
Copy link
Contributor

This PR splits the javadoc generation into per-artifact minisites. The publish_javadoc kokoro job will now publish each artifact's javadocs separately (and fix linking between all the javadoc sites).

This is not compatible with our current format of aggregating the javadocs into google-api-grpc and google-cloud-clients javadocs. The resulting docs should be better targeted and more usable.

@chingor13 chingor13 added do not merge Indicates a pull request not ready for merge, due to either quality or timing. type: docs Improvement to the documentation for an API. labels Apr 25, 2019
@chingor13 chingor13 requested a review from a team as a code owner April 25, 2019 17:36
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Apr 25, 2019
@codecov
Copy link

codecov bot commented Apr 25, 2019

Codecov Report

Merging #5019 into master will increase coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master    #5019      +/-   ##
============================================
+ Coverage     50.32%   50.32%   +<.01%     
+ Complexity    23680    23673       -7     
============================================
  Files          2238     2238              
  Lines        226060   226060              
  Branches      24955    24959       +4     
============================================
+ Hits         113766   113768       +2     
+ Misses       103689   103688       -1     
+ Partials       8605     8604       -1
Impacted Files Coverage Δ Complexity Δ
...able/gaxx/reframing/ReframingResponseObserver.java 90.82% <0%> (+1.83%) 30% <0%> (+1%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 909b0e8...361c5ed. Read the comment docs.

@codecov-io
Copy link

codecov-io commented Apr 25, 2019

Codecov Report

Merging #5019 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #5019   +/-   ##
=========================================
  Coverage      50.4%    50.4%           
- Complexity    23785    23800   +15     
=========================================
  Files          2251     2251           
  Lines        226791   226791           
  Branches      24966    24961    -5     
=========================================
  Hits         114320   114320           
  Misses       103864   103864           
  Partials       8607     8607

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6b78c52...1bc1264. Read the comment docs.

igorbernstein2 added a commit to igorbernstein2/google-cloud-java that referenced this pull request Apr 29, 2019
Ideally this should be done via a custom doclet that would filter out any classes annotated with `@InternalOnly`, but this doesn't currently exist. Please note that the exclusion are duplicated across google-cloud-clients/pom.xml and google-cloud-bigtable/pom.xml to support the Jeff's work on splitting javadocs into multiple sites (googleapis#5019)
igorbernstein2 added a commit that referenced this pull request Apr 29, 2019
)

Ideally this should be done via a custom doclet that would filter out any classes annotated with `@InternalOnly`, but this doesn't currently exist. Please note that the exclusion are duplicated across google-cloud-clients/pom.xml and google-cloud-bigtable/pom.xml to support the Jeff's work on splitting javadocs into multiple sites (#5019)
@yoshi-automation yoshi-automation added the 🚨 This issue needs some love. label May 2, 2019
@sduskis
Copy link
Contributor

sduskis commented May 26, 2019

@chingor13, this PR is a bit stale.

@chingor13
Copy link
Contributor Author

I think reorganizing the clients will supersede this PR.

@chingor13 chingor13 closed this May 26, 2019
chingor13 pushed a commit to googleapis/java-bigtable that referenced this pull request Sep 26, 2019
…035)

Ideally this should be done via a custom doclet that would filter out any classes annotated with `@InternalOnly`, but this doesn't currently exist. Please note that the exclusion are duplicated across google-cloud-clients/pom.xml and google-cloud-bigtable/pom.xml to support the Jeff's work on splitting javadocs into multiple sites (googleapis/google-cloud-java#5019)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes This human has signed the Contributor License Agreement. do not merge Indicates a pull request not ready for merge, due to either quality or timing. 🚨 This issue needs some love. type: docs Improvement to the documentation for an API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants