From 164fe5d1d26297dd767dd2fd633b5bc448eab8f6 Mon Sep 17 00:00:00 2001 From: Brett Smith Date: Mon, 26 Feb 2024 09:42:23 -0500 Subject: [PATCH] 21504: Modernize the SDK index * Note these packages also include client tools. * Highlight more mature SDKs. Attach caveats to the less mature ones. * Update Workbench text for v2. This is preparation to list most client tools here, and generally turn the "SDK reference" into a "User reference." Arvados-DCO-1.1-Signed-off-by: Brett Smith --- doc/sdk/index.html.textile.liquid | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/doc/sdk/index.html.textile.liquid b/doc/sdk/index.html.textile.liquid index b733d03bfc..9abfa9789f 100644 --- a/doc/sdk/index.html.textile.liquid +++ b/doc/sdk/index.html.textile.liquid @@ -9,13 +9,18 @@ Copyright (C) The Arvados Authors. All rights reserved. SPDX-License-Identifier: CC-BY-SA-3.0 {% endcomment %} -This section documents language bindings for the "Arvados API":{{site.baseurl}}/api/index.html and Keep that are available for various programming languages. Not all features are available in every SDK. The most complete SDK is the Python SDK. Note that this section only gives a high level overview of each SDK. Consult the "Arvados API":{{site.baseurl}}/api/index.html section for detailed documentation about Arvados API calls available on each resource. +This section documents client tools and language bindings for the "Arvados API":{{site.baseurl}}/api/index.html and Keep that are available for various programming languages. The most mature, popular packages are: + +* "Python SDK":{{site.baseurl}}/sdk/python/sdk-python.html (also includes essential command line tools such as @arv-put@ and @arv-get@) +* "Command line SDK":{{site.baseurl}}/sdk/cli/install.html (includes the @arv@ tool) + +Many Arvados Workbench pages provide examples of using the Python SDK and command line tools to access a given resource. Open "API details" from the action menu and open the tab with the example you're interested in. + +We provide API bindings for several other languages, but these SDKs may be missing some features or documentation: -* "Python SDK":{{site.baseurl}}/sdk/python/sdk-python.html (also includes essential command line tools such as "arv-put" and "arv-get") -* "Command line SDK":{{site.baseurl}}/sdk/cli/install.html ("arv") * "Go SDK":{{site.baseurl}}/sdk/go/index.html +* "Java SDK":{{site.baseurl}}/sdk/java-v2/index.html * "R SDK":{{site.baseurl}}/sdk/R/index.html * "Ruby SDK":{{site.baseurl}}/sdk/ruby/index.html -* "Java SDK v2":{{site.baseurl}}/sdk/java-v2/index.html -Many Arvados Workbench pages, under the *Advanced* tab, provide examples of API and SDK use for accessing the current resource . +Consult the "Arvados API":{{site.baseurl}}/api/index.html section for detailed documentation about Arvados API calls available on each resource. -- 2.30.2