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

readme: point service links to readme intro documentation #915

Merged
merged 1 commit into from
Jun 22, 2015

Conversation

stephenplusplus
Copy link

Hey, guys!

RE: googleapis/google-cloud-node#637

@jgeewax thinks it makes more sense to point the Service links (Google Cloud Datastore and Google Cloud Storage) to their respective sections in the readme.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jun 8, 2015
@dhermes
Copy link
Contributor

dhermes commented Jun 8, 2015

I don't really mind either way, but where do users get linked to the web service docs? @jgeewax

@jgeewax
Copy link
Contributor

jgeewax commented Jun 8, 2015

We can add a link to those... but keep in mind that the links we currently have aren't to the docs... they're to the crappy marketing-focused landing page...

If someone makes it all the way to our README, it's super unlikely they want to go to that marketing page. Maybe add in parens "(Google service documentation)" -> https://cloud.google.com/storage/docs/json_api/v1/ ?

@dhermes
Copy link
Contributor

dhermes commented Jun 8, 2015

Yes I like that. @stephenplusplus you want to change this PR or shall I do that?

@stephenplusplus
Copy link
Author

I can add it in. Were you thinking (Google service documentation) would go in the header, or as one of the links in the service paragraph?

I'm partial to keeping it with the rest of the links, leaving the header service links as a table of contents to skip around the readme.

Google Cloud Datastore

Google Cloud Datastore (service API docs) is a fully managed, schemaless database for storing non-relational data. Cloud Datastore automatically scales with your users and supports ACID transactions, high availability of reads and writes, strong consistency for reads and ancestor queries, and eventual consistency for all other queries.

See the Google Cloud Datastore docs for more details on how to activate Cloud Datastore for your project.

See the gcloud-python API datastore documentation to learn how to interact with the Cloud Datastore using this Client Library.

@jgeewax
Copy link
Contributor

jgeewax commented Jun 8, 2015 via email

@stephenplusplus
Copy link
Author

@dhermes
Copy link
Contributor

dhermes commented Jun 8, 2015

LGTM

dhermes added a commit that referenced this pull request Jun 22, 2015
readme: point service links to readme intro documentation
@dhermes dhermes merged commit 85c7e37 into googleapis:master Jun 22, 2015
@dhermes dhermes mentioned this pull request Jul 10, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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