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 readmes for all packages #1495

Merged
merged 7 commits into from
Aug 26, 2016

Conversation

stephenplusplus
Copy link
Contributor

@stephenplusplus stephenplusplus commented Aug 16, 2016

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Aug 16, 2016
@stephenplusplus stephenplusplus force-pushed the spp--module-readmes branch 3 times, most recently from 2c46f11 to 2782234 Compare August 16, 2016 17:39
@callmehiphop
Copy link
Contributor

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?

@stephenplusplus
Copy link
Contributor Author

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.

@callmehiphop
Copy link
Contributor

That's a fair point, maybe we should just have lengthy READMEs and if it becomes increasingly difficult to manage, we can rethink it?

@stephenplusplus
Copy link
Contributor Author

I'm cool with that.

@stephenplusplus
Copy link
Contributor Author

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

@coveralls
Copy link

coveralls commented Aug 18, 2016

Coverage Status

Coverage remained the same at 100.0% when pulling c9014c2 on stephenplusplus:spp--module-readmes into d606b2a on GoogleCloudPlatform:master.

@stephenplusplus stephenplusplus changed the title add bigquery readme add readmes for all packages Aug 19, 2016
@callmehiphop
Copy link
Contributor

@stephenplusplus it looks like there are a ton of references to the old repo/docs (e.g. gcloud-node). Even though there are redirects, we might want to update these.

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.

projectId: projectId
});

// ...you're good to go! See the next section to get started using the API.

This comment was marked as spam.

@stephenplusplus
Copy link
Contributor Author

Think I caught everything. Can you take a look?

@coveralls
Copy link

Coverage Status

Coverage remained the same at 99.966% when pulling 6031e69 on stephenplusplus:spp--module-readmes into 77c83a1 on GoogleCloudPlatform:master.

@callmehiphop callmehiphop merged commit 137efae into googleapis:master Aug 26, 2016
sofisl pushed a commit that referenced this pull request Oct 11, 2022
* 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
sofisl pushed a commit that referenced this pull request Oct 12, 2022
* 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
sofisl pushed a commit that referenced this pull request Oct 13, 2022
* 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
sofisl pushed a commit that referenced this pull request Nov 10, 2022
* 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
sofisl pushed a commit that referenced this pull request Nov 17, 2022
* 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
sofisl pushed a commit that referenced this pull request Jan 17, 2023
* 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
sofisl pushed a commit that referenced this pull request Sep 14, 2023
* 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
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