-
Notifications
You must be signed in to change notification settings - Fork 370
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: regenerate the samples/README.md #649
Conversation
Codecov Report
@@ Coverage Diff @@
## master #649 +/- ##
==========================================
+ Coverage 97.92% 97.94% +0.01%
==========================================
Files 9 9
Lines 869 874 +5
Branches 99 99
==========================================
+ Hits 851 856 +5
Misses 9 9
Partials 9 9
Continue to review full report at Codecov.
|
samples/README.md
Outdated
|
||
## Before you begin | ||
|
||
Before running the samples, make sure you've followed the steps in the | ||
[Before you begin section](../README.md#before-you-begin) of the client | ||
[Using the client library](https://github.com/googleapis/nodejs-storage#using-the-client-library) of the client |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't read very well. Maybe it should be quoted around the link, and we can probably remove all the "client library" phrasing. Maybe "...make sure you've followed these steps."
@bcoe can we land this? |
Fixes: googleapis/google-cloud-node#2868 we can now magically auto-generate both README.md and samples/README.md (this will become all the more powerful with discussions around auto-generating
.repo-metadata.json
(CC: @busunkim96, @jmdobry).This pull request:
samples/README.md
(this file is a slight simplification, no longer rendering the yargs CLI output, which is being removed from newer samples any ways).generate-scaffolding
from thepackage.json
(as it's now not used by anything).Related: googleapis/synthtool#214