Google-cloud-node: Source Code links broken in doc site

Created on 19 Sep 2016  路  6Comments  路  Source: googleapis/google-cloud-node

Steps to reproduce

  1. Navigate to a docs page for a release using the new tag notation (<package>-<version>). For example:
    https://googlecloudplatform.github.io/google-cloud-node/#/docs/datastore/0.3.0/datastore
  2. Click any "Source Code" link in the page.
    image

    For example:
    https://github.com/GoogleCloudPlatform/google-cloud-node/blob/0.3.0/packages/datastore/src/index.js#L305

    Result is 404. Correct URL should be:

    https://github.com/GoogleCloudPlatform/google-cloud-node/blob/datastore-0.3.0/packages/datastore/src/index.js#L305

This issue is the same as GoogleCloudPlatform/google-cloud-ruby#908, reported by @omaray. I am guessing that the fix will involve updating the GoogleCloudPlatform/gcloud-common site.

bug

All 6 comments

Ahh! Good find.. I think we're going to need a way to generate the correct tag name. Does everyone follow the {package}-{version} format?

Otherwise maybe we want to add the tag name to the toc.json file? Thoughts? @quartzmo @dwsupplee, @jdpedrie

We use a slash separator: {package}/{version} (I think the precedent we follow is git flow. Anyway, it is allowed.) Also, our package names are longer: google-cloud-datastore.

Ok, well I think it might be easier/safer to just add the tag name to the toc.json? Otherwise we could just add some conditional logic in the app to try and guess it based on the language.

Tag name in toc.json sounds ok to me.

We're not going to be able to split google-cloud-php into multiple packages for the foreseeable future, so allowing it to be configurable so we can opt out entirely makes the most sense to me.

Configurable sounds best to me as well

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jgeewax picture jgeewax  路  4Comments

nicolasgarnier picture nicolasgarnier  路  4Comments

stephenplusplus picture stephenplusplus  路  4Comments

VikramTiwari picture VikramTiwari  路  3Comments

ddunkin picture ddunkin  路  3Comments