Skip to content

Test docs for dead links #1203

Description

@jgeewax

On http://googlecloudplatform.github.io/gcloud-node/#/docs/v0.30.1/datastore/query

Looks like we moved these up a level (to the datastore instance) rather than defining datasets on their own.

Can we do two things:

  1. Fix the dead links?
  2. Make sure that dead links are caught in the build?

Activity

  1. richardkazuomiller commented on Apr 5, 2016

    @richardkazuomiller

    This is in reference to the fact that we used to do it like this right?

    var gcloud = require('gcloud');
    
    var dataset = gcloud.datastore.dataset({
      projectId: <my project id>
      keyFilename: <my key filename>
    });
    

    This broke all of my things 。・゚・(ノД`)・゚・。

  2. changed the title [-]Dead datastore links (dataset#createQuery, #runQuery)[/-] [+]Dead docs links[/+] on Apr 5, 2016
  3. stephenplusplus commented on Apr 5, 2016

    @stephenplusplus
    Contributor

    Catching dead links would be awesome. I'll fix the Datastore links and switch the focus of this issue to creating a step in our build task that catches these for us.

    @richardkazuomiller - it was indeed a breaking change: https://github.com/GoogleCloudPlatform/gcloud-node/releases/tag/v0.30.0, but this issue is just about fixing the links in our docs that point to the old dataset object.

  4. richardkazuomiller commented on Apr 5, 2016

    @richardkazuomiller

    Ah, I didn't see that. OK, looks like I have some refactoring to do lol

  5. changed the title [-]Dead docs links[/-] [+]Test docs for dead links[/+] on Apr 5, 2016
  6. stephenplusplus commented on Apr 5, 2016

    @stephenplusplus
    Contributor

    Sorry about that 😞 Feel free to tag us if we can help!

  7. jgeewax commented on Apr 5, 2016

    @jgeewax
    ContributorAuthor

    Sorry @richardkazuomiller :( Definitely feel your pain. We're still in the 0.x phase, so things are much more volatile than they otherwise would be.

  8. richardkazuomiller commented on Apr 5, 2016

    @richardkazuomiller

    @jgeewax No worries. I'll remember to check the releases page from now on (^^ゞ

  9. stephenplusplus commented on Apr 5, 2016

    @stephenplusplus
    Contributor

    @richardkazuomiller make sure your package.json has gcloud saved as a safe range. For example, if you have gcloud saved as "^0.29.0", only 0.29.y releases will be pulled down automatically, which won't contain any breaking changes. You'll have to manually install new 0.x releases, and the release notes will call out the breaking changes so you can be prepared.

  10. richardkazuomiller commented on Apr 5, 2016

    @richardkazuomiller

    @stephenplusplus Thanks for the tip. I always set the exact version number I use without a ^ or ~ and don't change it until I know it won't break in production, so go ahead and break all you like (^_-)-☆

  11. 1 remaining item

  12. added
    type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.
    on Mar 7, 2017
  13. evaogbe commented on Aug 9, 2017

    @evaogbe
    Contributor

    This issue may no longer be relevant due to its age. Feel free to re-open.

  14. evaogbe commented on Feb 2, 2021

    @evaogbe
    Contributor

    I am no longer on the team

  15. removed their assignment
    on Feb 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

priority: p2Moderately-important priority. Fix may not be included in next release.type: bugError or flaw in code with unintended results or allowing sub-optimal usage patterns.

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions