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

[Documentation Issue] Datastore client docs don't indicate what dataset ID is #1416

Closed
raggi opened this issue Jan 24, 2016 · 7 comments
Closed
Assignees
Labels
api: datastore Issues related to the Datastore API. priority: p2 Moderately-important priority. Fix may not be included in next release.

Comments

@raggi
Copy link

raggi commented Jan 24, 2016

Page Name: datastore-client
Release: 0.8.0

User could not identify what dataset_id was supposed to be. The docs for the argument to Client are not useful to end users. They need to be pointed to docs like these: https://cloud.google.com/datastore/docs/activate#accessing_an_existing_app_engine_datastore_from_another_platform

@dhermes dhermes added api: datastore Issues related to the Datastore API. docs labels Jan 24, 2016
@dhermes
Copy link
Contributor

dhermes commented Jan 24, 2016

@raggi I take it you're filing this on behalf of another user? The doc on a client isn't particularly useful, thanks for pointing it out.

I'm trying to understand a bit more. You're saying the user didn't know what the Google Cloud Datastore API was, but they were reading our library docs to try to learn that while they learn they library?

@dhermes dhermes changed the title [Documentation Issue] [Documentation Issue] Datastore client docs don't indicate what dataset ID is Jan 24, 2016
@raggi
Copy link
Author

raggi commented Jan 25, 2016

See https://botbot.me/freenode/appengine/2016-01-23/?tz=America/Los_Angeles

They wanted to run a quick one-off standalone process to query some data from their appengine datastore. They felt that deploying a task or an app was too heavy. Initially they were trying to use the appengine sandbox libs, but of course those won't work out. I pointed them to gcloud and they begun reading the docs. The docs sample code all contains setup like so datastore.Client() which unfortunately, while it handles most configuration by convention using gcloud auth, they still needed to provide a dataset id. They simply got an opaque error from their sample derived code that said EnvironmentError: Dataset ID could not be inferred. when I try to use datastore.Query()

They found the docs for the client initializer, and saw dataset_id there, but did not know what it was supposed to be set to. The pydocs were not helpful in this regard.

@dhermes
Copy link
Contributor

dhermes commented Jan 25, 2016

Thanks for the feedback! I totally agree it can be better.

@raggi
Copy link
Author

raggi commented Jan 25, 2016

Thanks Danny :)

@danoscarmike danoscarmike added this to COMMON in First 4 (GA) Feb 22, 2017
@danoscarmike danoscarmike moved this from COMMON to Cloud Datastore in First 4 (GA) Feb 22, 2017
@lukesneeringer lukesneeringer added the priority: p2 Moderately-important priority. Fix may not be included in next release. label Apr 19, 2017
@lukesneeringer
Copy link
Contributor

@dhermes I do not know the ins and outs of this -- is this something you could document in 15 minutes? If so, could you do it and send a PR? If not, let's bankruptcy this one.

@lukesneeringer
Copy link
Contributor

Actually going to assume that a bankruptcy is correct. Reopen if it is trivial (with a PR).

@dhermes
Copy link
Contributor

dhermes commented Aug 11, 2017

@lukesneeringer I think closing this is fine. I'm not really sure how I'd document this, though I think users should come to the library with a basic understanding of what the API does

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. priority: p2 Moderately-important priority. Fix may not be included in next release.
Projects
No open projects
First 4 (GA)
Cloud Datastore
Development

No branches or pull requests

3 participants