Skip to content

Add a note to SIA notebooks clarifying v1 versus v2 #240

@troyraen

Description

@troyraen

SIA v1 versus v2 can be confusing. We serve different datasets through each, and the calling syntax is different for each, so the user really needs to know (or at least know how to find out) which one they should be using.

We should add a note to the notebooks that use SIA to clarify that there are two versions, and explain how to learn which version should be used and how to use it. The note doesn't need to be long. It can probably just explain the basics and point to another notebook or IRSA webpage for details.

I don't think users will have any trouble when following any of our notebooks as written, but trying to adapt a notebook for a different dataset can get tricky. We've had at least one helpdesk question from a user who got stuck trying to do that. When looking at one example, it's not obvious that there even are two different versions, let alone how to deal with that.

Metadata

Metadata

Assignees

No one assigned

    Labels

    content: vo servicesContent related issues/PRs for notebooks with an IRSA VO service relevancedocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions