Bug #18671

[go sdk] update documentation

Added by Ward Vandewege 4 months ago. Updated 4 months ago.

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

0%

Estimated time:
Story points:
-

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

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

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

History

#1 Updated by Ward Vandewege 4 months ago

  • Description updated (diff)

#2 Updated by Ward Vandewege 4 months ago

  • Description updated (diff)

#3 Updated by Ward Vandewege 4 months ago

  • Description updated (diff)

#4 Updated by Ward Vandewege 4 months ago

  • Related to Bug #17275: Move Go Arvados RPC module into Go SDK & migrate to new API added

#5 Updated by Ward Vandewege 4 months ago

  • Description updated (diff)

#6 Updated by Ward Vandewege 4 months ago

  • Blocked by Feature #18672: [go sdk] describe + implement desired Go SDK added

Also available in: Atom PDF