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

Add dummy js files for datastore gapic/proto documentation #2351

Merged
merged 17 commits into from
Jun 30, 2017

Conversation

swcloud
Copy link
Contributor

@swcloud swcloud commented Jun 2, 2017

Fixes #1492

This should help fix #1492

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 2, 2017
@stephenplusplus stephenplusplus added status: do not merge api: datastore Issues related to the Datastore API. labels Jun 6, 2017
@stephenplusplus
Copy link
Contributor

Adding do not merge while I work on this and the docs parsing changes needed. I'll keep this PR updated with the progress.

@stephenplusplus stephenplusplus self-assigned this Jun 6, 2017
@stephenplusplus stephenplusplus added this to In Progress in State Jun 12, 2017
@googlebot
Copy link

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 cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

@googlebot googlebot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Jun 28, 2017
@stephenplusplus
Copy link
Contributor

@swcloud
Copy link
Contributor Author

swcloud commented Jun 28, 2017

@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.

@stephenplusplus
Copy link
Contributor

(1) It'll be nice if we can have a table to list all the data types like googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/v0.32.0/google/datastore/v1/datatypes

In progress 👍

(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?

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?

@stephenplusplus
Copy link
Contributor

@swcloud I pushed an update: https://stephenplusplus.github.io/gcloud-node/#/docs/datastore/master/datastore/v1/datastore_client

New:

@swcloud
Copy link
Contributor Author

swcloud commented Jun 29, 2017

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
It will just be a table of contents for the services and data types defined under that version

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?

@swcloud
Copy link
Contributor Author

swcloud commented Jun 29, 2017

@stephenplusplus "Data Types" looks awesome now!

@stephenplusplus
Copy link
Contributor

Makes sense. Updates: http://stephenplusplus.github.io/gcloud-node/#/docs/datastore/master/v1

@stephenplusplus stephenplusplus moved this from In Progress to Needs Review in State Jun 29, 2017
@swcloud
Copy link
Contributor Author

swcloud commented Jun 30, 2017

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: datastore Issues related to the Datastore API. cla: no This human has *not* signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documenting Gapic/Proto (autogen files)
3 participants