Use full paths for API documentation links
authorBrett Smith <brett.smith@curii.com>
Thu, 28 Dec 2023 19:29:30 +0000 (14:29 -0500)
committerBrett Smith <brett.smith@curii.com>
Thu, 28 Dec 2023 19:29:30 +0000 (14:29 -0500)
Most of the cross-reference links in our documentation point to a
specific page. These links are unusual in that they point to a
directory. Lately the linkchecker has been intermittently complaining
about them:

  URL        `file:///tmp/workspace/developer-run-tests-doc-and-sdk-R/doc/.site/api'
  Name       `API documentation'
  Parent URL file:///tmp/workspace/developer-run-tests-doc-and-sdk-R/doc/.site/admin/scoped-tokens.html, line 306, col 576
  Real URL   file:///tmp/workspace/developer-run-tests-doc-and-sdk-R/doc/.site/api/
  Warning    [file-missing-slash] Added trailing slash to
             directory.
  Result     Valid: directory

This causes a test failure. Spell out the rest of the link to prevent
that. No issue #.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

doc/admin/scoped-tokens.html.textile.liquid

index de09b4261528a83c64a3306cbee5b5707ba264bb..0147aa168b645e16eebcfcc06ad826c644644773 100644 (file)
@@ -18,9 +18,9 @@ Another example is situations where admin access is required but there is risk o
 
 h2. Defining scopes
 
-A "scope" consists of a HTTP method and API path.  A token can have multiple scopes.  Token scopes act as a whitelist, and the API server checks the HTTP method and the API path of every request against the scopes of the request token.  Scopes are also described on the "API Authorization":{{site.baseurl}}/api/tokens.html#scopes page of the "API documentation":{{site.baseurl}}/api .
+A "scope" consists of a HTTP method and API path.  A token can have multiple scopes.  Token scopes act as a whitelist, and the API server checks the HTTP method and the API path of every request against the scopes of the request token.  Scopes are also described on the "API Authorization":{{site.baseurl}}/api/tokens.html#scopes page of the "API documentation":{{site.baseurl}}/api/index.html.
 
-These examples use @/arvados/v1/collections@, but can be applied to any endpoint.  Consult the "API documentation":{{site.baseurl}}/api to determine the endpoints for specific methods.
+These examples use @/arvados/v1/collections@, but can be applied to any endpoint.  Consult the "API documentation":{{site.baseurl}}/api/index.html to determine the endpoints for specific methods.
 
 The scope @["GET", "/arvados/v1/collections"]@ will allow only GET or HEAD requests for the list of collections.  Any other HTTP method or path (including requests for a specific collection record, eg a request with path @/arvados/v1/collections/zzzzz-4zz18-0123456789abcde@) will return a permission error.