Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs in package-info need a refresh #1643

Closed
3 tasks
tswast opened this issue Oct 7, 2021 · 4 comments
Closed
3 tasks

docs in package-info need a refresh #1643

tswast opened this issue Oct 7, 2021 · 4 comments
Assignees
Labels
api: bigquery Issues related to the googleapis/java-bigquery API. type: docs Improvement to the documentation for an API.

Comments

@tswast
Copy link
Contributor

tswast commented Oct 7, 2021

https://github.com/googleapis/java-bigquery/blob/main/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/package-info.java

Since https://cloud.google.com/java/docs/reference/google-cloud-bigquery/latest/com.google.cloud.bigquery is where I landed when trying to understand the package from the API reference docs, package-info should get a refresh.

  • Link to CreateTableAndLoadData.java 404s.
  • Needs a link to BigQuery interface docs.
  • Ideally link to main BigQuery docs, perhaps sample browser landing page for BigQuery?
@product-auto-label product-auto-label bot added the api: bigquery Issues related to the googleapis/java-bigquery API. label Oct 7, 2021
@tswast
Copy link
Contributor Author

tswast commented Oct 7, 2021

Also, as identified here: #1641 (review) If the CHANGELOG is going to be the landing page, it needs more information as well.

@eaball35
Copy link
Contributor

eaball35 commented Oct 7, 2021

The landing page for the library is what is first in the nav. The goal is to use the README as the overview page. We had this originally, but recently removed it for now because we realized at the time of generation the README we included was not updated. Follow b/200726473 as I include it again and will update the repo-metadata again.

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 and other languages and libraries have chosen to update.

@meredithslota meredithslota added the type: docs Improvement to the documentation for an API. label Oct 11, 2021
@eaball35
Copy link
Contributor

eaball35 commented Mar 23, 2022

Fixing this in the repos will fix it in the docs. Changelogs are managed by release-please and I believe that package-info page is generated by the gapic-generator-java. It might make sense to move this issue to feature requests for those two pages in those repos.

@eaball35
Copy link
Contributor

Moved issue to gapic-generator googleapis/sdk-platform-java#992

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. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

3 participants