site: support permalinks. fixes #184 #188

stephenplusplus · 2014-09-05T23:41:40Z

This does a few things to support permalinks. First, methods are isolated to their own page, e.g. docs/datastore/dataset/runQuery. They can be accessed via the / url (so a reader can copy and paste the url in the address bar to share), or if they come from one of our jsdoc reference links: https://github.com/GoogleCloudPlatform/gcloud-node/blob/master/lib/datastore/query.js#L33, a url like: docs/datastore/dataset#runQuery will do a seamless replacement of the # to a /, and take the user to the right spot.

If a specified method doesn't exist, they are directed to the class documentation.

~~Also, I just found a bug. Will report back when it's good to go 👍~~

Update: good to go. Here're some links:

http://stephenplusplus.github.io/gcloud-node/#/docs
http://stephenplusplus.github.io/gcloud-node/#/docs/datastore/dataset
http://stephenplusplus.github.io/gcloud-node/#/docs/datastore/dataset/runQuery
http://stephenplusplus.github.io/gcloud-node/#/docs/datastore/dataset#runQuery

docs/components/docs/docs.js

+          methods.singleMethod = methodName;
+          return methods;
+        } else {
+          $location.path('/docs/' + module + '/' + cl);


ryanseys · 2014-09-06T01:07:52Z

Whoa, whoa this is really confusing. Maybe it's just me but I don't want a separate page for each method, I just want anchors so that I can link to certain sections of the documentation. I also just find it confusing in general. I don't want to click a link expecting it to take me somewhere with more information on the topic but it ends up just taking me to a page with the same information isolated.

stephenplusplus · 2014-09-06T01:14:54Z

I don't want to click a link expecting it to take me somewhere with more information on the topic but it ends up just taking me to a page with the same information isolated.

That makes sense. Instead of the method name being a link, I can add a hashtag beside it as a link. That's the general understood "this is a permalink" icon.

Perhaps with more googling, I can find a way to implement the traditional deep link behavior. I haven't found it yet, so this is the best it can be for offering a way to link to a method.

stephenplusplus · 2014-09-06T01:32:39Z

Updated to add hover-triggered # links.

ryanseys · 2014-09-06T01:44:49Z

Ooh, this is much better.

site: support permalinks. fixes #184

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

docs: update sample to show method inside of async function

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/96fb0e9d-e02a-4451-878f-e646368369cc/targets - [ ] To automatically regenerate this PR, check this box. Source-Link: googleapis/synthtool@94421c4

[![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) | [`^14.0.0` -> `^16.0.0`](https://renovatebot.com/diffs/npm/@types%2fnode/14.17.32/16.11.6) | [![age](https://badges.renovateapi.com/packages/npm/@types%2fnode/16.11.6/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/@types%2fnode/16.11.6/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/@types%2fnode/16.11.6/compatibility-slim/14.17.32)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/@types%2fnode/16.11.6/confidence-slim/14.17.32)](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. --- - [ ] 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-media-translation).

…andwritten libraries (#188) - [ ] Regenerate this pull request now. PiperOrigin-RevId: 429395631 Source-Link: googleapis/googleapis@84594b3 Source-Link: googleapis/googleapis-gen@ed74f97 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWQ3NGY5NzBmZDgyOTE0ODc0ZTZiMjdiMDQ3NjNjZmE2NmJhZmU5YiJ9

@samhutton

- [ ] Regenerate this pull request now. PiperOrigin-RevId: 474338479 Source-Link: googleapis/googleapis@d5d35e0 Source-Link: googleapis/googleapis-gen@efcd3f9 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWZjZDNmOTM5NjJhMTAzZjY4ZjAwM2UyYTFlZWNkZTZmYTIxNmEyNyJ9 feat: Add compliant_but_disallowed_services field to the v1beta1 Workload proto Committer: @samhutton PiperOrigin-RevId: 471822190 Source-Link: googleapis/googleapis@61f75b4 Source-Link: googleapis/googleapis-gen@9abf7bc Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOWFiZjdiYzI3MTU3MGY3MDczYzg5YzBkNGJlYjNiODZhNjY2NzhjYiJ9

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/4dafeee7-014d-47f6-a950-0e8b4e9c606e/targets - [ ] To automatically regenerate this PR, check this box. PiperOrigin-RevId: 345596855 Source-Link: googleapis/googleapis@d189e87

🤖 I have created a release *beep* *boop* --- ## [2.2.0](googleapis/nodejs-video-transcoder@v2.1.0...v2.2.0) (2022-06-29) ### Features * support regapic LRO ([#187](googleapis/nodejs-video-transcoder#187)) ([7924434](googleapis/nodejs-video-transcoder@7924434)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

🤖 I have created a release *beep* *boop* --- ## [4.1.0](googleapis/nodejs-security-private-ca@v4.0.0...v4.1.0) (2022-06-30) ### Features * support regapic LRO ([#187](googleapis/nodejs-security-private-ca#187)) ([2b2f553](googleapis/nodejs-security-private-ca@2b2f553)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

🤖 I have created a release \*beep\* \*boop\* --- ### [2.5.3](https://www.github.com/googleapis/nodejs-bigquery-storage/compare/v2.5.2...v2.5.3) (2021-07-21) ### Bug Fixes * **deps:** google-gax v2.17.1 ([#188](https://www.github.com/googleapis/nodejs-bigquery-storage/issues/188)) ([e49f7ee](https://www.github.com/googleapis/nodejs-bigquery-storage/commit/e49f7ee0413948779842b3b9d4faf5addc4c4db6)) * Updating WORKSPACE files to use the newest version of the Typescript generator. ([#190](https://www.github.com/googleapis/nodejs-bigquery-storage/issues/190)) ([8649cc6](https://www.github.com/googleapis/nodejs-bigquery-storage/commit/8649cc6ae0a4e6ae807ba9e5af438ca0ffc9592a)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@types/mocha](https://togithub.com/DefinitelyTyped/DefinitelyTyped) | devDependencies | major | [`^7.0.0` -> `^8.0.0`](https://renovatebot.com/diffs/npm/@types%2fmocha/7.0.2/8.0.0) | --- ### 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#googleapis/nodejs-recaptcha-enterprise).

Source-Link: googleapis/synthtool@d229a12 Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-nodejs:latest@sha256:74ab2b3c71ef27e6d8b69b1d0a0c9d31447777b79ac3cd4be82c265b45f37e5e Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Alexander Fenster <fenster@google.com>

stephenplusplus force-pushed the permalink branch 2 times, most recently from 11f7a25 to 2da7cb4 Compare September 6, 2014 00:26

ryanseys reviewed Sep 6, 2014
View reviewed changes

docs/components/docs/docs.js

methods.singleMethod = methodName;

return methods;

} else {

$location.path('/docs/' + module + '/' + cl);

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

site: support permalinks. fixes googleapis#184

69bbaa5

stephenplusplus force-pushed the permalink branch from b0443e5 to 69bbaa5 Compare September 6, 2014 16:24

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

Merge pull request #188 from stephenplusplus/permalink

5dde946

site: support permalinks. fixes #184

silvolu merged commit 5dde946 into googleapis:master Sep 8, 2014

stephenplusplus mentioned this pull request May 8, 2015

Permalink link in the docs is... pretty small. Could we make it a larger click target? #555

Closed

sofisl mentioned this pull request Sep 15, 2022

migrate code from googleapis/nodejs-redis #3360

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Sep 15, 2022

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

257475b

* 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 Sep 27, 2022

chore: move CONTRIBUTING.md to root (#188)

36b77eb

sofisl mentioned this pull request Sep 27, 2022

migrate code from googleapis/nodejs-video-intelligence #3374

Closed

4 tasks

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

chore(deps): update dependency nyc to v14 (#188)

0ff6ef2

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

chore(deps): update dependency nyc to v14 (#188)

be9d358

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

chore: move CONTRIBUTING.md to root (#188)

2dc2cb9

This was referenced Nov 9, 2022

migrate code from googleapis/nodejs-video-intelligence #3507

Closed

migrate code from googleapis/nodejs-video-intelligence #3519

Merged

migrate code from googleapis/nodejs-text-to-speech #3528

Merged

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

docs: update sample to show method inside of async function (#188)

83cac07

docs: update sample to show method inside of async function

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

chore: release 2.1.0 (#188)

77cbd23

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: remove tslint.json (#188)

9377400

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-containeranalysis #3550

Merged

4 tasks

sofisl mentioned this pull request Nov 11, 2022

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

Merged

4 tasks

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

chore(cloud-rad): delete api-extractor config (#188)

7bc4533

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-media-translation #3558

Merged

4 tasks

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-os-config #3560

Merged

4 tasks

sofisl mentioned this pull request Nov 11, 2022

migrate code from googleapis/nodejs-assured-workloads #3565

Merged

4 tasks

This was referenced Nov 11, 2022

migrate code from googleapis/nodejs-cloudbuild #3566

Merged

migrate code from googleapis/nodejs-video-transcoder #3571

Merged

This was referenced Nov 11, 2022

migrate code from googleapis/nodejs-security-private-ca #3572

Merged

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

Merged

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

fix(deps): google-gax v2.17.1 (#188)

777bfba

This was referenced Nov 16, 2022

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

Merged

migrate code from googleapis/nodejs-bigquery-connection #3646

Merged

sofisl mentioned this pull request Nov 16, 2022

migrate code from googleapis/nodejs-retail #3648

Merged

4 tasks

sofisl mentioned this pull request Jan 17, 2023

migrate code from googleapis/nodejs-vision #3860

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Jan 17, 2023

Update CI config (#188)

52ccefc

sofisl mentioned this pull request Sep 13, 2023

migrate code from googleapis/nodejs-automl #4655

Closed

4 tasks

sofisl pushed a commit that referenced this pull request Sep 13, 2023

build: ignore proto files in test coverage (#188)

7d02ccd

sofisl mentioned this pull request Sep 14, 2023

migrate code from googleapis/nodejs-automl #4656

Merged

4 tasks

sofisl pushed a commit that referenced this pull request Sep 14, 2023

Release v0.9.1 (#188)

f8176d0

sofisl mentioned this pull request Sep 14, 2023

migrate code from googleapis/nodejs-dns #4657

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

site: support permalinks. fixes #184 #188

site: support permalinks. fixes #184 #188

stephenplusplus commented Sep 5, 2014

This comment was marked as spam.

This comment was marked as spam.

ryanseys commented Sep 6, 2014

stephenplusplus commented Sep 6, 2014

stephenplusplus commented Sep 6, 2014

ryanseys commented Sep 6, 2014

site: support permalinks. fixes #184 #188

site: support permalinks. fixes #184 #188

Conversation

stephenplusplus commented Sep 5, 2014

This comment was marked as spam.

This comment was marked as spam.

ryanseys commented Sep 6, 2014

stephenplusplus commented Sep 6, 2014

stephenplusplus commented Sep 6, 2014

ryanseys commented Sep 6, 2014