-
Notifications
You must be signed in to change notification settings - Fork 592
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 readmes for all packages #1495
add readmes for all packages #1495
Conversation
2c46f11
to
2782234
Compare
I like it, my only real concern is the duplicated documentation, mainly auth. I understand why we want it here, but it also might be a pain for us to update in the future if it changes. WDYT about linking to auth on the docs site or main README? Or else trying to generate the READMEs programmatically? |
Linking is okay. Let me know if this is overthinking it: if I link to a guide, the URL couldn't be tied to any particular version, so it would go to the latest release, which could be incorrect. |
That's a fair point, maybe we should just have lengthy READMEs and if it becomes increasingly difficult to manage, we can rethink it? |
I'm cool with that. |
2782234
to
4143a62
Compare
@callmehiphop PTAL. I updated the "Enable the following APIs" section of each module's readme to include the relevant APIs for the module. Also, I made google-cloud's publish script copy master/readme.md to master/packages/google-cloud/readme.md -- which means all readme updates should be made on master/readme.md. |
@stephenplusplus it looks like there are a ton of references to the old repo/docs (e.g. |
credentials: require('./path/to/keyfile.json') | ||
}); | ||
|
||
// ...you're good to go! See the next section to get started using the APIs. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
projectId: projectId | ||
}); | ||
|
||
// ...you're good to go! See the next section to get started using the API. |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
c9014c2
to
76758dd
Compare
Think I caught everything. Can you take a look? |
6031e69
to
5f0b75d
Compare
5f0b75d
to
70bc888
Compare
* add bigquery readme * add all readmes * copy readme as part of release script * gcloud-node -> google-cloud-node * fix youre good to gos * add resource manager scope * exclude unecessary files
* add bigquery readme * add all readmes * copy readme as part of release script * gcloud-node -> google-cloud-node * fix youre good to gos * add resource manager scope * exclude unecessary files
* add bigquery readme * add all readmes * copy readme as part of release script * gcloud-node -> google-cloud-node * fix youre good to gos * add resource manager scope * exclude unecessary files
* add bigquery readme * add all readmes * copy readme as part of release script * gcloud-node -> google-cloud-node * fix youre good to gos * add resource manager scope * exclude unecessary files
* add bigquery readme * add all readmes * copy readme as part of release script * gcloud-node -> google-cloud-node * fix youre good to gos * add resource manager scope * exclude unecessary files
* add bigquery readme * add all readmes * copy readme as part of release script * gcloud-node -> google-cloud-node * fix youre good to gos * add resource manager scope * exclude unecessary files
* add bigquery readme * add all readmes * copy readme as part of release script * gcloud-node -> google-cloud-node * fix youre good to gos * add resource manager scope * exclude unecessary files
Fixes #1491
Probably easiest to review by looking here: https://github.com/stephenplusplus/gcloud-node/tree/spp--module-readmes/packages