Skip to content

Conversation

@eaball35
Copy link
Contributor

@eaball35 eaball35 commented Oct 6, 2021

No description provided.

@eaball35 eaball35 requested a review from a team October 6, 2021 23:09
@eaball35 eaball35 requested a review from a team as a code owner October 6, 2021 23:09
@eaball35 eaball35 added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Oct 6, 2021
@eaball35 eaball35 requested a review from shollyman October 6, 2021 23:09
@product-auto-label product-auto-label bot added the api: bigquery Issues related to the googleapis/java-bigquery API. label Oct 6, 2021
@google-cla google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Oct 6, 2021
@eaball35 eaball35 removed the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Oct 7, 2021
Copy link
Contributor

@shollyman shollyman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one ended up being a little surprising to me. Landing on the changelog, it wasn't clear to me where the heck the library docs were, It took me a second time visiting the URL to realize the super dense left nav.

Then, I tried mangling the URL and visited https://cloud.google.com/java/docs/reference/google-cloud-bigquery/latest/

This is a much better landing page, but suffers from the problem that the left nav is omitted, likely because the page isn't listed in the toc file.

I'd consider resolving that issue and landing users on a more appropriate page, given that this file gets heavily re-used to inject links into emitted docs.

@eaball35 eaball35 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 7, 2021
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Oct 7, 2021
@eaball35 eaball35 added the automerge Merge the pull request once unit tests and other checks pass. label Oct 7, 2021
@eaball35 eaball35 merged commit 2b942da into main Oct 7, 2021
@eaball35 eaball35 deleted the cloud-rad-docs branch October 7, 2021 17:51
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label Oct 7, 2021
@tswast tswast mentioned this pull request Oct 7, 2021
3 tasks
@eaball35
Copy link
Contributor Author

eaball35 commented Oct 7, 2021

This one ended up being a little surprising to me. Landing on the changelog, it wasn't clear to me where the heck the library docs were, It took me a second time visiting the URL to realize the super dense left nav.

Then, I tried mangling the URL and visited https://cloud.google.com/java/docs/reference/google-cloud-bigquery/latest/

This is a much better landing page, but suffers from the problem that the left nav is omitted, likely because the page isn't listed in the toc file.

I'd consider resolving that issue and landing users on a more appropriate page, given that this file gets heavily re-used to inject links into emitted docs.

@shollyman Hey! I agree the /latest link you provided would be the better overview page. We had that originally, which is why this page still exists (although it should be deleted).... but we decided to remove it for now because due to the current timing of doc generation, the README versions are not updated before included. The goal is to include these again, follow b/200726473 as I add those back in and I will update these links again when ready.

googleapis.dev docs will continue to exist until we're ready to redirect traffic. We can leave the repo-metatdata.json link as the old one or update to something more specific like https://cloud.google.com/java/docs/reference/google-cloud-bigquery/latest/com.google.cloud.bigquery if you'd prefer. We are updating these links as that is how they are generated in the table on https://cloud.google.com/java/docs/reference.

gcf-owl-bot bot added a commit that referenced this pull request Oct 4, 2022
* chore: [java] generation with shared deps 3.0.4

* fix for tests
Source-Link: googleapis/synthtool@c3ad3cc
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:5643a4e1b729803e67ddceee450e87052527b37cac394bf900b4f8e3d1bb3e9b
gcf-merge-on-green bot pushed a commit that referenced this pull request Oct 10, 2022
* chore: [java] generation with shared deps 3.0.4

* fix for tests
Source-Link: https://togithub.com/googleapis/synthtool/commit/c3ad3cc9d876a3dd897cc511cf5ef921784851ae
Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-java:latest@sha256:5643a4e1b729803e67ddceee450e87052527b37cac394bf900b4f8e3d1bb3e9b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: bigquery Issues related to the googleapis/java-bigquery API. cla: yes This human has signed the Contributor License Agreement.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants