-
Notifications
You must be signed in to change notification settings - Fork 591
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
Add dummy js files for datastore gapic/proto documentation #2351
Add dummy js files for datastore gapic/proto documentation #2351
Conversation
Adding |
So there's good news and bad news. 👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there. 😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request. Note to project maintainer: This is a terminal state, meaning the |
@stephenplusplus That's certainly a good progress! A few comments here: (1) It'll be nice if we can have a table to list all the data types like https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/v0.32.0/google/datastore/v1/datatypes (2) When I click 'v1', the page content is the GAPIC documentation, right? To be consistent with Ruby and Php, we should have a separate item under 'v1' which is 'DatastoreClient' to have that content. 'v1' should provide an overview. Is it hard to do? (3) The GAPIC comments are out-dated since we changed the GAPIC entry point. I need to regen for all the APIs that use GAPIC. |
In progress 👍
Would it be possible to get Ruby to conform to this way, which I think is a bit better? Currently, clicking their "v1" lands you on an empty page. If we go forward with your suggestion, what would the overview be? |
@swcloud I pushed an update: https://stephenplusplus.github.io/gcloud-node/#/docs/datastore/master/datastore/v1/datastore_client New:
|
For Ruby, they are adding a table of content to fill the blank for V1 menu item. https://github.com/googleapis/toolkit/pull/1388/files#diff-9c98f244b3240854328ea915b946e635L52 Your suggestion to move GAPIC documentation content to V1 menu item has an issue for an API with multiple services such as PubSub which has PublisherClient and SubscriberClient because we want them to have their own pages and corresponding sub menu items. Is it easy to do to add a simple TOC for V1 menu item? |
@stephenplusplus "Data Types" looks awesome now! |
Makes sense. Updates: http://stephenplusplus.github.io/gcloud-node/#/docs/datastore/master/v1 |
@stephenplusplus That's all we want! Great Job! BTW, I added another PR to include docs for a few other gapic-based APIs such as logging, pubsub and spanner. |
Fixes #1492
This should help fix #1492