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.

Sign up for GitHub

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

Jump to bottom

docs #169

Merged
merged 8 commits into from
Sep 4, 2014
Merged

docs #169

merged 8 commits into from
Sep 4, 2014

Conversation

stephenplusplus
Copy link
Contributor

This should be interesting.

Here's the new structure: https://github.com/stephenplusplus/gcloud-node/tree/site/docs

Assuming all works well, Travis will run our new docs process, which uses dox. This takes the JSdoc and spits out JSON, that is then transformed to match our new template.

@ryanseys
Copy link
Contributor

ryanseys commented Sep 3, 2014

New template?

@stephenplusplus
Copy link
Contributor Author

Yep, updated the post with a little more info.

@silvolu
Copy link
Contributor

silvolu commented Sep 3, 2014

@stephenplusplus can you remove the language selector for now? After that I'll merge and then we'll iterate on it.

@silvolu
Copy link
Contributor

silvolu commented Sep 3, 2014

Also I've just noticed that a lot of the links in the reference docs are not working, e.g.:
http://googlecloudplatform.github.io/#/docs/datastore
http://googlecloudplatform.github.io/#/docs/storage

@stephenplusplus
Copy link
Contributor Author

Ok, thanks for catching that. The site was designed to work from /, but because of the /gcloud-node/ subdirectory we consider our "root", some areas got thrown off. Will fix.

@stephenplusplus
Copy link
Contributor Author

Updated: http://googlecloudplatform.github.io/gcloud-node/#/

@silvolu
Copy link
Contributor

silvolu commented Sep 3, 2014

Experiencing a strange issue. If i navigate to the docs, scroll down and click on the storage link (just below Returns), the storage page is loaded, but instead of seeing the top of the page, I see the copy function.
Can you reproduce?

@stephenplusplus
Copy link
Contributor Author

Reproduced. Fixed via this solution: http://stackoverflow.com/a/24549173/776934

stephenplusplus
stephenplusplus reviewed Sep 3, 2014
View reviewed changes
docs/index.html
<script src="/gcloud-node/components/docs/docs.js"></script>

<!-- Google Analytics: change UA-XXXXX-X to be your site's ID. -->

This comment was marked as spam.

Sign in to view

@beriberikix
Copy link
Contributor

Here are requested changes from our email conversation:

  • change the font of the code snippet, Monaco (I think Monaco is Mac-only so we'll need fallback
  • sample code: 0.8em, less padding, reduce contrast (more like overall theme)
  • add line numbers on every line

@beriberikix
Copy link
Contributor

Also, can we add the GA snippet to every page?

<script>
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

  ga('create', 'UA-49880327-13', 'auto');
  ga('send', 'pageview');

</script>

@stephenplusplus
Copy link
Contributor Author

change the font of the code snippet, Monaco (I think Monaco is Mac-only so we'll need fallback

I will see what I can do. 👍

sample code: 0.8em, less padding, reduce contrast (more like overall theme)

The entire code snippet style has changed, so all of the above are changed. It's using a separate plug-in, with a separate theme chosen to match GitHub colors. Can the original requester of the change take another look and see if they still feel that way?

add line numbers on every line

This request made more sense than having line numbers every 5 lines, like it was previously. But again, since this has changed, do line numbers really offer any value?

@stephenplusplus
Copy link
Contributor Author

Also, can we add the GA snippet to every page?

#169 (comment) Just needed the id :)

@stephenplusplus
Copy link
Contributor Author

Analytics + font changes: http://googlecloudplatform.github.io/gcloud-node/#/

@beriberikix
Copy link
Contributor

@jgeewax for font, @rakyll for styling and line #

@ryanseys
Copy link
Contributor

ryanseys commented Sep 4, 2014

Add a favicon too to the <head>. Here's the one used by https://googlecloudplatform.github.io:

<link rel="shortcut icon" href="https://cloud.google.com/images/gcp-favicon.ico">

@rakyll
Copy link
Contributor

rakyll commented Sep 4, 2014

Sorry for not catching up with the PR earlier. It looks excellent!

@stephenplusplus
Copy link
Contributor Author

Woo! Updates are in.

sofisl pushed a commit that referenced this pull request Nov 11, 2022
@renovate-bot
chore(deps): update dependency @types/node to v14 (#169)
d3f8ab8 
[![WhiteSource Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [@types/node](https://togithub.com/DefinitelyTyped/DefinitelyTyped) | [`^13.7.1` -> `^14.0.0`](https://renovatebot.com/diffs/npm/@types%2fnode/13.13.52/14.17.0) | [![age](https://badges.renovateapi.com/packages/npm/@types%2fnode/14.17.0/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@types%2fnode/14.17.0/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@types%2fnode/14.17.0/compatibility-slim/13.13.52)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@types%2fnode/14.17.0/confidence-slim/13.13.52)](https://docs.renovatebot.com/merge-confidence/) |

---

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

---

 - [ ] <!-- rebase-check -->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-bigquery-storage).
@sofisl sofisl mentioned this pull request Nov 11, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@parthea
chore: add api_shortname and library_type to repo metadata (#169)
de91019
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@gcf-owl-bot
fix: preserve default values in x-goog-request-params header (#169)
26e71a9 
- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 474338479

Source-Link: googleapis/googleapis@d5d35e0

Source-Link: googleapis/googleapis-gen@efcd3f9
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWZjZDNmOTM5NjJhMTAzZjY4ZjAwM2UyYTFlZWNkZTZmYTIxNmEyNyJ9
sofisl pushed a commit that referenced this pull request Nov 11, 2022
@release-please
chore(main): release 1.1.3 (#170)
ee5c8f1 
🤖 I have created a release *beep* *boop*
---


## [1.1.3](https://togithub.com/googleapis/nodejs-service-management/compare/v1.1.2...v1.1.3) (2022-11-10)


### Bug Fixes

* Preserve default values in x-goog-request-params header ([#169](https://togithub.com/googleapis/nodejs-service-management/issues/169)) ([ef47431](https://togithub.com/googleapis/nodejs-service-management/commit/ef4743106afc35191647a626c8f3a8a08634ebd1))
* Regenerated protos JS and TS definitions ([#178](https://togithub.com/googleapis/nodejs-service-management/issues/178)) ([9c00293](https://togithub.com/googleapis/nodejs-service-management/commit/9c00293b6213b8ba0e2d56fd2208d90b60c38d0d))

---
This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
@sofisl sofisl mentioned this pull request Nov 11, 2022
Merged
4 tasks
@release-please release-please bot mentioned this pull request Nov 12, 2022
Merged
sofisl pushed a commit that referenced this pull request Nov 16, 2022
@alexander-fenster
fix: regen protos and tests, formatting (#169)
db58b67
sofisl pushed a commit that referenced this pull request Nov 16, 2022
@release-please
chore(main): release 1.0.0 (#375)
5408e24 
🤖 I have created a release *beep* *boop*
---


## 1.0.0 (2022-05-18)


### ⚠ BREAKING CHANGES

* update library to use Node 12 (#374)
* rename parent to project in SearchRelatedAccountGroupMembershipsRequest (#370)
* remove key management API (#366)
* Remove RecaptchaEnterpriseServiceV1Beta1Client.
* The library now supports Node.js v10+. The last version to support Node.js v8 is tagged legacy-8 on NPM.
* upgrade engines field to >=8.10.0 (#2)

### Features

* add crud support for keys ([#84](googleapis/nodejs-recaptcha-enterprise#84)) ([adfc3f9](googleapis/nodejs-recaptcha-enterprise@adfc3f9))
* add GetMetrics and MigrateKey methods to reCAPTCHA enterprise API ([#318](googleapis/nodejs-recaptcha-enterprise#318)) ([55b1adc](googleapis/nodejs-recaptcha-enterprise@55b1adc))
* add new reCAPTCHA Enterprise fraud annotations ([#334](googleapis/nodejs-recaptcha-enterprise#334)) ([24fdff1](googleapis/nodejs-recaptcha-enterprise@24fdff1))
* add plural and singular resource descriptor ([#78](googleapis/nodejs-recaptcha-enterprise#78)) ([a67ffa7](googleapis/nodejs-recaptcha-enterprise@a67ffa7))
* add reCAPTCHA Enterprise account defender API methods ([#328](googleapis/nodejs-recaptcha-enterprise#328)) ([2099c50](googleapis/nodejs-recaptcha-enterprise@2099c50))
* Add support for Password Check through the private_password_leak_verification field in the reCAPTCHA Assessment ([#376](googleapis/nodejs-recaptcha-enterprise#376)) ([7c1583c](googleapis/nodejs-recaptcha-enterprise@7c1583c))
* add the v1 API surface ([#141](googleapis/nodejs-recaptcha-enterprise#141)) ([bb1bd33](googleapis/nodejs-recaptcha-enterprise@bb1bd33))
* deferred client initialization ([#128](googleapis/nodejs-recaptcha-enterprise#128)) ([3de999e](googleapis/nodejs-recaptcha-enterprise@3de999e))
* drop node8 support, support for async iterators ([#145](googleapis/nodejs-recaptcha-enterprise#145)) ([cc4cc51](googleapis/nodejs-recaptcha-enterprise@cc4cc51))
* export protos in src/index.ts ([ffd77ca](googleapis/nodejs-recaptcha-enterprise@ffd77ca))
* introduces style enumeration ([#234](googleapis/nodejs-recaptcha-enterprise#234)) ([35f1bb6](googleapis/nodejs-recaptcha-enterprise@35f1bb6))
* load protos from JSON, grpc-fallback support ([7a4b2a6](googleapis/nodejs-recaptcha-enterprise@7a4b2a6))
* move to typescript code generation ([#87](googleapis/nodejs-recaptcha-enterprise#87)) ([11051db](googleapis/nodejs-recaptcha-enterprise@11051db))
* support apiEndpoint override in client constructor ([#30](googleapis/nodejs-recaptcha-enterprise#30)) ([1192afd](googleapis/nodejs-recaptcha-enterprise@1192afd))
* turns on self-signed JWT feature flag ([#311](googleapis/nodejs-recaptcha-enterprise#311)) ([c12da34](googleapis/nodejs-recaptcha-enterprise@c12da34))
* update scopes and classifications ([#60](googleapis/nodejs-recaptcha-enterprise#60)) ([b216630](googleapis/nodejs-recaptcha-enterprise@b216630))


### Bug Fixes

* allow calls with no request, add JSON proto ([ab643f8](googleapis/nodejs-recaptcha-enterprise@ab643f8))
* **browser:** check for fetch on window ([#226](googleapis/nodejs-recaptcha-enterprise#226)) ([8eb79dd](googleapis/nodejs-recaptcha-enterprise@8eb79dd))
* **build:** switch primary branch to main ([#315](googleapis/nodejs-recaptcha-enterprise#315)) ([2fc99ad](googleapis/nodejs-recaptcha-enterprise@2fc99ad))
* DEADLINE_EXCEEDED retry code is idempotent ([#10](googleapis/nodejs-recaptcha-enterprise#10)) ([746151c](googleapis/nodejs-recaptcha-enterprise@746151c))
* **deps:** bump google-gax to 1.7.5 ([#68](googleapis/nodejs-recaptcha-enterprise#68)) ([0605bb8](googleapis/nodejs-recaptcha-enterprise@0605bb8))
* **deps:** google-gax v2.17.0 with mTLS ([#294](googleapis/nodejs-recaptcha-enterprise#294)) ([45c12e5](googleapis/nodejs-recaptcha-enterprise@45c12e5))
* **deps:** google-gax v2.17.1 ([#297](googleapis/nodejs-recaptcha-enterprise#297)) ([15640f1](googleapis/nodejs-recaptcha-enterprise@15640f1))
* **deps:** google-gax v2.24.1 ([#309](googleapis/nodejs-recaptcha-enterprise#309)) ([de80090](googleapis/nodejs-recaptcha-enterprise@de80090))
* **deps:** pin TypeScript below 3.7.0 ([0e96508](googleapis/nodejs-recaptcha-enterprise@0e96508))
* **deps:** require google-gax v2.12.0 ([#270](googleapis/nodejs-recaptcha-enterprise#270)) ([ab16a25](googleapis/nodejs-recaptcha-enterprise@ab16a25))
* **deps:** update dependency google-gax to v1 ([#17](googleapis/nodejs-recaptcha-enterprise#17)) ([0f9e159](googleapis/nodejs-recaptcha-enterprise@0f9e159))
* do not modify options object, use defaultScopes ([#222](googleapis/nodejs-recaptcha-enterprise#222)) ([807b692](googleapis/nodejs-recaptcha-enterprise@807b692))
* do not retry request on DEADLINE_EXCEEDED ([a6e9f4a](googleapis/nodejs-recaptcha-enterprise@a6e9f4a))
* **docs:** bump the release level to beta ([#76](googleapis/nodejs-recaptcha-enterprise#76)) ([8a2e2c0](googleapis/nodejs-recaptcha-enterprise@8a2e2c0))
* **docs:** link to reference docs section on googleapis.dev ([#35](googleapis/nodejs-recaptcha-enterprise#35)) ([14ada6b](googleapis/nodejs-recaptcha-enterprise@14ada6b))
* **docs:** move to new client docs URL ([#32](googleapis/nodejs-recaptcha-enterprise#32)) ([6a95276](googleapis/nodejs-recaptcha-enterprise@6a95276))
* **docs:** snippets are now replaced in jsdoc comments ([#74](googleapis/nodejs-recaptcha-enterprise#74)) ([b3c31fc](googleapis/nodejs-recaptcha-enterprise@b3c31fc))
* enum, bytes, and Long types now accept strings ([394cfd8](googleapis/nodejs-recaptcha-enterprise@394cfd8))
* export explicit version from protos.js ([#150](googleapis/nodejs-recaptcha-enterprise#150)) ([0bfb3c7](googleapis/nodejs-recaptcha-enterprise@0bfb3c7))
* GoogleAdsError missing using generator version after 1.3.0 ([#279](googleapis/nodejs-recaptcha-enterprise#279)) ([6dc35a7](googleapis/nodejs-recaptcha-enterprise@6dc35a7))
* include the correct version of node in a header ([#46](googleapis/nodejs-recaptcha-enterprise#46)) ([2cc8099](googleapis/nodejs-recaptcha-enterprise@2cc8099))
* make request optional in all cases ([#290](googleapis/nodejs-recaptcha-enterprise#290)) ([e18a1d1](googleapis/nodejs-recaptcha-enterprise@e18a1d1))
* pass x-goog-request-params header for streaming calls ([983411e](googleapis/nodejs-recaptcha-enterprise@983411e))
* proper fallback option handling ([#180](googleapis/nodejs-recaptcha-enterprise#180)) ([52fe53d](googleapis/nodejs-recaptcha-enterprise@52fe53d))
* proper routing headers ([4d1b1d3](googleapis/nodejs-recaptcha-enterprise@4d1b1d3))
* regen protos and tests, formatting ([#169](googleapis/nodejs-recaptcha-enterprise#169)) ([731fe3b](googleapis/nodejs-recaptcha-enterprise@731fe3b))
* remove eslint, update gax, fix generated protos, run the generator ([#155](googleapis/nodejs-recaptcha-enterprise#155)) ([21b09f5](googleapis/nodejs-recaptcha-enterprise@21b09f5))
* remove key management API ([#366](googleapis/nodejs-recaptcha-enterprise#366)) ([44a5a4b](googleapis/nodejs-recaptcha-enterprise@44a5a4b))
* rename parent to project in SearchRelatedAccountGroupMembershipsRequest ([#370](googleapis/nodejs-recaptcha-enterprise#370)) ([aad0883](googleapis/nodejs-recaptcha-enterprise@aad0883))
* synth.py clean up for multiple version ([#172](googleapis/nodejs-recaptcha-enterprise#172)) ([ee1c250](googleapis/nodejs-recaptcha-enterprise@ee1c250))
* Updating WORKSPACE files to use the newest version of the Typescript generator. ([#299](googleapis/nodejs-recaptcha-enterprise#299)) ([6787e23](googleapis/nodejs-recaptcha-enterprise@6787e23))
* use compatible version of google-gax ([dfb174a](googleapis/nodejs-recaptcha-enterprise@dfb174a))
* use require() to load JSON protos ([#273](googleapis/nodejs-recaptcha-enterprise#273)) ([fdbc0fe](googleapis/nodejs-recaptcha-enterprise@fdbc0fe))


### Build System

* update library to use Node 12 ([#374](googleapis/nodejs-recaptcha-enterprise#374)) ([4042ae2](googleapis/nodejs-recaptcha-enterprise@4042ae2))
* upgrade engines field to >=8.10.0 ([#2](googleapis/nodejs-recaptcha-enterprise#2)) ([94d6a49](googleapis/nodejs-recaptcha-enterprise@94d6a49))

---
This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
@sofisl sofisl mentioned this pull request Nov 16, 2022
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Nov 17, 2022
@jmdobry
Switch to individual API packages. (#169)
5c7b4a3 
* Switch to individual API packages.

* Address comments

* Address comments
sofisl pushed a commit that referenced this pull request Nov 17, 2022
@pickypg @stephenplusplus
Show proper response structure in vm.getMetadata example (#169)
60e2cc8 
This updates the documentation for `vm.getMetadata` calls to show the
real response structure returned by calls using `Promise`s.

- [X] Appropriate docs were updated (if necessary)
This was referenced Nov 17, 2022
Merged
Merged
sofisl pushed a commit that referenced this pull request Nov 18, 2022
@yoshi-automation @JustinBeckwith
chore: add license header to protos.d.ts (#169)
015f984
@sofisl sofisl mentioned this pull request Jan 10, 2023
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Jan 10, 2023
@dpebot @JustinBeckwith
feat: add excluded field field for storage (#169)
e2486cd 
feat: add excluded field field for storage
@sofisl sofisl mentioned this pull request Jan 17, 2023
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Jan 17, 2023
@jmdobry
Switch to individual API packages. (#169)
a4ea8f5 
* Switch to individual API packages.

* Address comments

* Address comments
sofisl pushed a commit that referenced this pull request Jan 24, 2023
@dpebot @JustinBeckwith
Switch to let/const (#169)
6d1e1a9
sofisl pushed a commit that referenced this pull request Jan 25, 2023
@dpebot @JustinBeckwith
Switch to let/const (#169)
8028bf3
sofisl pushed a commit that referenced this pull request Jan 26, 2023
@release-please
chore: release 1.8.0 (#169)
987db08 
🤖 I have created a release \*beep\* \*boop\*
---
## [1.8.0](https://www.github.com/googleapis/nodejs-ai-platform/compare/v1.7.4...v1.8.0) (2021-07-14)


### Features

* Removes AcceleratorType.TPU_V2 and TPU_V3 constants ([#167](https://www.github.com/googleapis/nodejs-ai-platform/issues/167)) ([72d153e](https://www.github.com/googleapis/nodejs-ai-platform/commit/72d153ea7732a0d4b73a4ab8d727679523adf6df))
---


This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
@sofisl sofisl mentioned this pull request Jan 26, 2023
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Sep 14, 2023
@renovate @JustinBeckwith
chore(deps): update dependency gts to ^0.9.0 (#169)
83982a0
@sofisl sofisl mentioned this pull request Sep 14, 2023
Merged
4 tasks
@takeratta takeratta mentioned this pull request Oct 27, 2023
Open
@takeratta takeratta mentioned this pull request Dec 14, 2023
Open
This was referenced Jan 2, 2024
Open
Open
@takeratta takeratta mentioned this pull request Mar 16, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@stephenplusplus @ryanseys @silvolu @beriberikix @rakyll