-
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
docs: generate uniform service overviews #1475
docs: generate uniform service overviews #1475
Conversation
3180d3c
to
38419fb
Compare
|
||
The full set of options which can be passed to `<%= pkgJson.name %>` are | ||
outlined in our | ||
[Authentication guide](#/docs/<%= className %>/<%= pkgJson.version %>/guides/authentication). |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
Where would the overview content be visible to the user? In the collapsable menu like today? Or before the constructor description? |
There is only one body of text that describes a service and its constructor. So the Getting Started and Overview sections are gone. All content would appear as part of the constructor's description. |
911d2f6
to
082f724
Compare
This has been absorbed by #1479. |
It looks like the overview changes from this PR weren't carried over into #1479. The docs site still show 3 different sections for each API;
There is only meant to be one now, under the label of the constructor, i.e.: |
4335de0
to
df4f483
Compare
Updated this PR, PTAL. I also stuck Datastore constants on the prototype... it was never very convenient accessing them: var datastore = require('@google-cloud/datastore')({ ... });
datastore.int // undefined (until now) Are there other constants I need to do this for? Until we get this change in, I don't think we should officially "release" (publishing the release notes), since the docs right now are pretty confusing, e.g. the first example on the BigQuery module's page tells you to |
df4f483
to
2ab470c
Compare
2ab470c
to
0e31d81
Compare
@@ -29,7 +29,7 @@ | |||
"docs": "node ./scripts/docs/packages.js", | |||
"bundle": "node ./scripts/docs/bundle.js", | |||
"lint": "jshint scripts/ packages/ system-test/ test/ && jscs packages/ system-test/ test/", | |||
"test": "npm run docs && mocha test/docs.js packages/*/test/*.js", | |||
"test": "npm run docs && npm run bundle && mocha test/docs.js packages/*/test/*.js", |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
@stephenplusplus LGTM, I think we should wait for an update to the docs site before merging this though so that our overview isn't collapsed. |
RE: #1471
@callmehiphop I wanted to get your thoughts before I move forward. The changes in this PR:
@example
blocks. This was mostly used to show how to create a client-- that is now covered in the generated description._.template()
, using a common templating syntax. This is done because each description should be different, depending on the context the user is viewing the docs in:umbrellaMode
or not.scripts/docs.buildOverview.js
that takes a class name, likebigquery
, and returns the templated description. This returned description should be pre-pended to any existing description a constructor might have.Constructor
@example
blocks are currently used to initialize variables that are used throughout the rest of the class's examples. Removing these blocks created a bit of a problem, so as a solution, intest/docs.js
, it will prepend example code with a manual instantiation.