docs: fix examples, style optionals #229

stephenplusplus · 2014-09-19T01:34:56Z

The live site has a couple issues I didn't catch during PR review time (:():

The sidebar active link styling isn't working
Some examples are cut off (ex: http://googlecloudplatform.github.io/gcloud-node/#/docs/v0.6.0/datastore/dataset)
We had some old code examples (new gcloud.storage.Bucket() etc)

I added some tweaks that hopefully add some readability:

Styled optional parameters minimally (italic + optional prefix)
Moved > Getting started with gcloud block to the top of the page

Waiting on my gh-pages to build, then I'll have a live example up. Keep an eye: http://stephenplusplus.github.io/gcloud-node/#/docs

docs: fix examples, style optionals

* fix(docs): reference docs should link to section of googleapis.dev with API reference * fix(docs): make anchors work in jsdoc

- [ ] Regenerate this pull request now. PiperOrigin-RevId: 408439482 Source-Link: googleapis/googleapis@b9f6184 Source-Link: googleapis/googleapis-gen@eb888bc Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWI4ODhiYzIxNGVmYzdiZjQzYmY0NjM0YjQ3MDI1NDU2NWE2NTlhNSJ9

* fix(docs): reference docs should link to section of googleapis.dev with API reference * fix(docs): make anchors work in jsdoc

…229)

[![WhiteSource Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [sinon](https://sinonjs.org/) ([source](https://togithub.com/sinonjs/sinon)) | [`^9.0.1` -> `^10.0.0`](https://renovatebot.com/diffs/npm/sinon/9.2.4/10.0.0) | [![age](https://badges.renovateapi.com/packages/npm/sinon/10.0.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/sinon/10.0.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/sinon/10.0.0/compatibility-slim/9.2.4)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/sinon/10.0.0/confidence-slim/9.2.4)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>sinonjs/sinon</summary> ### [`v10.0.0`](https://togithub.com/sinonjs/sinon/blob/master/CHANGELOG.md#1000--2021-03-22) [Compare Source](https://togithub.com/sinonjs/sinon/compare/v9.2.4...v10.0.0) ================== - Upgrade nise to 4.1.0 - Use [@sinonjs/eslint-config](https://togithub.com/sinonjs/eslint-config)[@4](https://togithub.com/4) => Adopts ES2017 => Drops support for IE 11, Legacy Edge and legacy Safari </details> --- ### Renovate configuration :date: **Schedule**: "after 9am and before 3pm" (UTC). :vertical_traffic_light: **Automerge**: Disabled by config. Please merge this manually once you are satisfied. :recycle: **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. :no_bell: **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-web-risk).

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/bfc25924-7584-48c7-bead-23b659b9a9b8/targets - [ ] To automatically regenerate this PR, check this box. Source-Link: googleapis/synthtool@ba9918c

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

[![WhiteSource Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [sinon](https://sinonjs.org/) ([source](https://togithub.com/sinonjs/sinon)) | [`^13.0.0` -> `^14.0.0`](https://renovatebot.com/diffs/npm/sinon/13.0.2/14.0.0) | [![age](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/compatibility-slim/13.0.2)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/sinon/14.0.0/confidence-slim/13.0.2)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>sinonjs/sinon</summary> ### [`v14.0.0`](https://togithub.com/sinonjs/sinon/blob/HEAD/CHANGES.md#1400) [Compare Source](https://togithub.com/sinonjs/sinon/compare/v13.0.2...v14.0.0) - [`c2bbd826`](https://togithub.com/sinonjs/sinon/commit/c2bbd82641444eb5b32822489ae40f185afbbf00) Drop node 12 (Morgan Roderick) > And embrace Node 18 > > See https://nodejs.org/en/about/releases/ *Released by Morgan Roderick on 2022-05-07.* </details> --- ### Configuration 📅 **Schedule**: "after 9am and before 3pm" (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [WhiteSource Renovate](https://renovate.whitesourcesoftware.com). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/nodejs-billing).

* build!: Update library to use Node 12 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/940354f9-15cd-4361-bbf4-dc9af1426979/targets - [ ] To automatically regenerate this PR, check this box. Source-Link: googleapis/synthtool@99c93fe

* docs(samples): add example tags to generated samples PiperOrigin-RevId: 408439482 Source-Link: googleapis/googleapis@b9f6184 Source-Link: googleapis/googleapis-gen@eb888bc Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWI4ODhiYzIxNGVmYzdiZjQzYmY0NjM0YjQ3MDI1NDU2NWE2NTlhNSJ9 * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/15d2fc95-8ec0-48d8-8ade-d188b4874078/targets - [ ] To automatically regenerate this PR, check this box. PiperOrigin-RevId: 345596855 Source-Link: googleapis/googleapis@d189e87

* test: enable retry on errors * try this again, should have added a comment * chore: fiddle with jitter * debug * force build * chore: fix config * build: final settings that I landed on * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

docs: fix examples, style optionals

0311366

stephenplusplus added in progress and removed in progress labels Sep 19, 2014

stephenplusplus mentioned this pull request Sep 19, 2014

Storage docs show link to datastore dataset docs when they shouldn't. #232

Closed

silvolu added a commit that referenced this pull request Sep 19, 2014

Merge pull request #229 from stephenplusplus/fix-docs

12d018f

docs: fix examples, style optionals

silvolu merged commit 12d018f into googleapis:master Sep 19, 2014

beriberikix removed the ready for review label Sep 19, 2014

snyk-bot mentioned this pull request Jan 31, 2020

[Snyk] Fix for 1 vulnerabilities enterstudio/google-cloud-node#73

Open

snyk-bot mentioned this pull request Aug 16, 2020

[Snyk] Security upgrade gcs-resumable-upload from 0.7.7 to 2.1.1 enterstudio/google-cloud-node#103

Open

sofisl mentioned this pull request Oct 11, 2022

migrate code from googleapis/nodejs-language #3395

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Oct 11, 2022

update to .nycrc with --all enabled (#229)

96f1605

sofisl mentioned this pull request Oct 12, 2022

migrate code from googleapis/nodejs-bigquery-data-transfer #3399

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Oct 12, 2022

fix(docs): link to reference docs section on googleapis.dev (#229)

683c5ee

* fix(docs): reference docs should link to section of googleapis.dev with API reference * fix(docs): make anchors work in jsdoc

sofisl pushed a commit that referenced this pull request Oct 12, 2022

feat: support apiEndpoint override (#229)

a0fa05d

This was referenced Oct 12, 2022

migrate code from googleapis/nodejs-resource-manager #3402

Merged

migrate code from googleapis/nodejs-monitoring-dashboards #3408

Merged

sofisl pushed a commit that referenced this pull request Oct 13, 2022

update to .nycrc with --all enabled (#229)

1e19b03

sofisl pushed a commit that referenced this pull request Oct 13, 2022

fix(docs): link to reference docs section on googleapis.dev (#229)

02fb8b9

* fix(docs): reference docs should link to section of googleapis.dev with API reference * fix(docs): make anchors work in jsdoc

sofisl pushed a commit that referenced this pull request Nov 11, 2022

build: switch to GitHub magic proxy (#229)

2f979af

This was referenced Nov 11, 2022

migrate code from googleapis/nodejs-dataproc #3533

Merged

migrate code from googleapis/nodejs-iot #3544

Merged

sofisl pushed a commit that referenced this pull request Nov 11, 2022

fix(docs): bump the release level to beta (#229)

30e4917

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-scheduler #3547

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Nov 11, 2022

build: set AUTOSYNTH_MULTIPLE_COMMITS=true for context aware commits (#…

612eac1

…229)

This was referenced Nov 11, 2022

migrate code from googleapis/nodejs-datalabeling #3548

Merged

migrate code from googleapis/nodejs-web-risk #3549

Merged

sofisl pushed a commit that referenced this pull request Nov 11, 2022

chore: migrate to owl bot (#229)

e34c5dc

sofisl pushed a commit that referenced this pull request Nov 11, 2022

chore: release 3.6.0 (#229)

9633743

Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>

This was referenced Nov 11, 2022

migrate code from googleapis/nodejs-grafeas #3551

Merged

migrate code from googleapis/nodejs-secret-manager #3553

Merged

This was referenced Nov 11, 2022

migrate code from googleapis/nodejs-billing #3556

Merged

migrate code from googleapis/nodejs-service-directory #3557

Merged

sofisl added a commit that referenced this pull request Nov 11, 2022

build!: update library to use Node 12 (#229)

f694170

* build!: Update library to use Node 12 Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-talent #3568

Merged

4 tasks

This was referenced Nov 11, 2022

migrate code from googleapis/nodejs-game-servers #3569

Merged

migrate code from googleapis/nodejs-bigquery-storage #3599

Merged

sofisl pushed a commit that referenced this pull request Nov 11, 2022

build: add generated samples to .eslintignore (#229)

d364dab

sofisl mentioned this pull request Nov 16, 2022

migrate code from googleapis/nodejs-recaptcha-enterprise #3645

Merged

4 tasks

sofisl mentioned this pull request Nov 30, 2022

migrate code from googleapis/nodejs-datacatalog #3689

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Nov 30, 2022

feat(samples): add samples (#229)

0af61b9

sofisl mentioned this pull request Jan 26, 2023

migrate code from googleapis/nodejs-ai-platform #3892

Merged

4 tasks

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: fix examples, style optionals #229

docs: fix examples, style optionals #229

stephenplusplus commented Sep 19, 2014

docs: fix examples, style optionals #229

docs: fix examples, style optionals #229

Conversation

stephenplusplus commented Sep 19, 2014