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

docs: add the sheets quickstart #1022

Merged
merged 1 commit into from
Feb 25, 2018
Merged

docs: add the sheets quickstart #1022

merged 1 commit into from
Feb 25, 2018

Conversation

JustinBeckwith
Copy link
Contributor

We're seeing a bunch of reports of old docs from codesite. This is the first step to fixing #999. We will need to follow up with tests, and then submit a CL to embed the code snippet.

@JustinBeckwith JustinBeckwith requested review from alexander-fenster and a team February 24, 2018 06:35
@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Feb 24, 2018
throw err;
}
const rows = res.data.values;
if (rows.length == 0) {

This comment was marked as spam.

This comment was marked as spam.

@grant
Copy link
Contributor

grant commented Mar 2, 2018

@JustinBeckwith @alexander-fenster

Thanks for the Sheets addition. I want to let you know that I'm releasing G Suite Node samples (quickstarts + snippets) for ~6 G Suite products in a week or so. I appreciate the effort to updating this one and putting it on GitHub, but it looks like this code is directly pulled from the quickstart with some touchups.

I've since added the dependency version to the sheets quickstart so that it does break. It will be updated and linked to GitHub when the gsuitedevs/node-samples repo is published.

In order to not have duplicate code, and to match the style of the samples/ that doesn't have quickstarts like this, would you consider adding a cross link to the G Suite samples instead of having 2 versions when the node-samples repo is published? It seems like adding this quickstart is trying to patch the root problem.

@JustinBeckwith
Copy link
Contributor Author

JustinBeckwith commented Mar 3, 2018

I want to let you know that I'm releasing G Suite Node samples (quickstarts + snippets) for ~6 G Suite products in a week or so.

Yes! This is amazing!

it looks like this code is directly pulled from the quickstart with some touchups.

That's because I submitted the CL to update the quickstart first 🤣 I wanted to get that updated quickly (people were getting led astray) while we worked on getting real samples checked in and tested.

I've since added the dependency version to the sheets quickstart so that it does break.

The other approach we could take here is to instruct users to install at head, but keep all the samples in this repo so they're always tested. I'm a humble PM volunteering time here, and the tests in this lib far from cover all scenarios. I want to make sure our samples are tested here so I know that I'm not breaking anyone.

In order to not have duplicate code, and to match the style of the samples/ that doesn't have quickstarts like this, would you consider adding a cross link to the G Suite samples instead of having 2 versions when the node-samples repo is published? It seems like adding this quickstart is trying to patch the root problem.

I would prefer to move all our node-samples for this library over here, for the reasons stated above. As we do make breaking changes, we can make sure we're fixing the docs in the same PR that introduces the problem. Also, it's always nice to have more node.js folks to look at PRs in these repos :)

This appears to have a lot of moving parts. If you'd like to chat on Monday, happy to hop on a GVC!

@grant
Copy link
Contributor

grant commented Mar 3, 2018

Thanks for volunteering time. I'm sure some sample overlap is fine.

That's because I submitted the CL to update the quickstart first 🤣 I wanted to get that updated quickly (people were getting led astray) while we worked on getting real samples checked in and tested.

The best way to update the quickstart would be to send a message to the DevSite author saying that the docs sample is broken. Copying this one sample into another repo is not a great fix. There were 5 other product samples that I updated as well that weren't reported. Installing at HEAD is not a reliable solution for every language/product sample.


Some more background:

The G Suite samples are planned to be in a similar structure to GCP's samples:

https://github.com/GoogleCloudPlatform/nodejs-docs-samples

There are ~10 languages, so any solution of adding samples to client repos would have to be consistent will all clients:
https://github.com/google?utf8=%E2%9C%93&q=google-api-&type=&language=

There are complications (like no python client, multiple sample repos) that makes adding samples to client repos difficult. It's really a more complicated discussion that was talked about with OSPO/github-requests@ a few months ago.

If we want to start a discussion about consolidating all Google Node samples in this repo, including GCP, this client library, G Suite, googlemaps, etc. then we should start a conversation with Max/OSPO and all sample repo maintainers.

The main point I'd like to get across is that copying one G Suite sample from DevSite so there are two versions is not a great solution to fixing this problem. Simply ask the Google author for the docs to be fixed.

@JustinBeckwith
Copy link
Contributor Author

I'm in total agreement that having two versions of these samples is a bad idea. I didn't know y'all were writing and maintaining these samples - this is great!

Now on the repo where the samples live - this is probably a discussion that needs to include @jonparrott @jmdobry and @ace-n. Folks - what's the future of the nodejs-docs-samples repo? I was under the understanding that we're actively trying to pull things out of there, and move samples closer to the repo with the actual implementations. Is that accurate?

@grant
Copy link
Contributor

grant commented Mar 4, 2018

Note: All G Suite docs and samples are maintained by G Suite DevRel.

I'll set up a meeting next week for coordinating these samples. Be wary that G Suite and @google-cloud are a bit different, and that any solution proposed should cover .NET, Android, Apps Script, Go, iOS, Java, JS (client-side), Node, PHP, Python and Ruby equally.

@JustinBeckwith JustinBeckwith deleted the 999 branch March 11, 2018 02:46
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