Project

General

Profile

Backlogs error: Couldn't find RbRelease with 'id'=69 (ActiveRecord::RecordNotFound)
Actions

Bug #18671

open

[go sdk] update documentation

Added by Ward Vandewege about 3 years ago. Updated about 2 years ago.

Status:
New
Priority:
Normal
Assigned To:
-
Category:
-
Target version:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Story points:
-
Release:
Release relationship:
Auto

Description

The documentation at

https://doc.arvados.org/sdk/go/index.html
https://doc.arvados.org/sdk/go/example.html

refers to the old Go SDK. The godoc link for the go/sdk/arvados directory describes the current SDK. We want to move over to an RPC interface as per #18672.

  • The godoc should be updated/improved to incorporate all the examples from the examples page at our documentation site.
  • Examples should be added for important features (e.g. the CollectionFileSystem)
  • The old pages should be removed from the Arvados documentation, with only the godoc link remaining. Any Go programmer should be able to use the Arvados Go sdk with just the godoc page.

Related issues 2 (2 open0 closed)

Related to Arvados - Bug #17275: Move Go Arvados RPC module into Go SDK & migrate to new APINew

Actions
Blocked by Arvados - Feature #18672: [go sdk] describe + implement desired Go SDKNew

Actions
Actions

Also available in: Atom PDF