docs: preview #98 at 9f4262a

Author: github-actions[bot]

pr-preview/pr-98/configuration/index.html

@@ -78,7 +78,7 @@ <h1 id="configuration">Configuration</h1>
 <td><code>SOURCE_PROXY_URL</code></td>
 <td><code>--proxy-url</code></td>
 <td><code>https://data.source.coop</code></td>
-<td>The environment: the data proxy, and the session and credentials to use</td>
+<td>The environment: the data proxy (the S3 endpoint for AWS tools), and the session and credentials to use</td>
 </tr>
 <tr>
 <td><code>SOURCE_API_URL</code></td>
@@ -204,7 +204,7 @@ <h3 id="sign-in-options">Sign-in options</h3>
 <td><code>--proxy-url</code></td>
 <td><code>SOURCE_PROXY_URL</code></td>
 <td><code>https://data.source.coop</code></td>
-<td>S3 proxy URL for STS. Also selects the environment of the session.</td>
+<td>The data proxy: the S3 endpoint for AWS tools, and the URL for STS. Also selects the environment of the session.</td>
 </tr>
 <tr>
 <td><code>--role-arn</code></td>

pr-preview/pr-98/demos/auth-logout.json

@@ -1,16 +1,16 @@
 {
- "duration": 13.88,
+ "duration": 14.566,
  "steps": [
   {
    "time": 0.757,
    "label": "$ source-coop auth logout --json | jq -c"
   },
   {
-   "time": 5.372,
+   "time": 6.045,
    "label": "$ source-coop auth status"
   },
   {
-   "time": 9.241,
+   "time": 9.935,
    "label": "$ source-coop creds; echo \"exit $?\""
   }
  ],

pr-preview/pr-98/demos/auth-logout.svg

@@ -63,6 +63,8 @@
   </nav>
   <main id="main">
 <h1 id="reading-data-with-aws-tools">Reading data with AWS tools</h1>
+<p>Each product's data is at <code>s3://ACCOUNT/PRODUCT/</code> on the data proxy, <code>https://data.source.coop</code>. Public data needs no sign-in. <a href="https://docs.source.coop/data-proxy">Access Data</a> on docs.source.coop shows how to read it, anonymously or signed in, with the AWS CLI, DuckDB, GDAL and Python.</p>
+<p>This section covers the credentials the CLI gives AWS tools, for restricted data and for <a href="../uploading-data-with-aws-tools/">writes</a>.</p>
 <h3 id="aws-credentialprocess">AWS <code>credential_process</code></h3>
 <ol>
 <li>

pr-preview/pr-98/reading-data-with-aws-tools/index.html

@@ -58,7 +58,7 @@
   <nav class="toc" aria-label="Guide">
     <details open>
       <summary>Contents</summary>
-      <ul><li class="group">Get started</li><li><a href="../">Overview</a></li><li><a href="../install/">Install</a></li><li><a href="../signing-in/">Signing in</a></li><li class="group">Work with data</li><li><a href="../reading-data-with-aws-tools/">Reading data with AWS tools</a></li><li><a href="../uploading-data-with-aws-tools/">Uploading data with AWS tools</a></li><li class="group">Manage source.coop</li><li><a href="../accounts/">Accounts</a></li><li><a href="../products/">Products</a></li><li><a href="../members/">Members</a></li><li><a href="../invitations/">Invitations</a></li><li><a href="../service-accounts/">Service accounts</a></li><li class="group">How commands work</li><li><a href="../prompts/">Prompts</a></li><li><a href="../browsing-with--i/">Browsing with <code>-i</code></a></li><li><a href="../shell-completion/">Shell completion</a></li><li class="group">Automate</li><li><a href="../scripts-and-ai-agents/" aria-current="page">Scripts and AI agents</a><ul><li><a href="#agent-skill">Agent skill</a></li><li><a href="#output">Output</a></li><li><a href="#json">JSON</a></li><li><a href="#exit-codes">Exit codes</a></li><li><a href="#use-the-api-without-signing-in">Use the API without signing in</a></li><li><a href="#use-your-session-with-other-tools">Use your session with other tools</a></li></ul></li><li><a href="../any-api-request/">Any API request</a></li><li class="group">Reference</li><li><a href="../configuration/">Configuration</a></li><li><a href="../credential-storage/">Credential storage</a></li><li><a href="../troubleshooting/">Troubleshooting</a></li></ul>
+      <ul><li class="group">Get started</li><li><a href="../">Overview</a></li><li><a href="../install/">Install</a></li><li><a href="../signing-in/">Signing in</a></li><li class="group">Work with data</li><li><a href="../reading-data-with-aws-tools/">Reading data with AWS tools</a></li><li><a href="../uploading-data-with-aws-tools/">Uploading data with AWS tools</a></li><li class="group">Manage source.coop</li><li><a href="../accounts/">Accounts</a></li><li><a href="../products/">Products</a></li><li><a href="../members/">Members</a></li><li><a href="../invitations/">Invitations</a></li><li><a href="../service-accounts/">Service accounts</a></li><li class="group">How commands work</li><li><a href="../prompts/">Prompts</a></li><li><a href="../browsing-with--i/">Browsing with <code>-i</code></a></li><li><a href="../shell-completion/">Shell completion</a></li><li class="group">Automate</li><li><a href="../scripts-and-ai-agents/" aria-current="page">Scripts and AI agents</a><ul><li><a href="#agent-skill">Agent skill</a></li><li><a href="#output">Output</a></li><li><a href="#json">JSON</a></li><li><a href="#exit-codes">Exit codes</a></li><li><a href="#read-data">Read data</a></li><li><a href="#use-the-api-without-signing-in">Use the API without signing in</a></li><li><a href="#use-your-session-with-other-tools">Use your session with other tools</a></li></ul></li><li><a href="../any-api-request/">Any API request</a></li><li class="group">Reference</li><li><a href="../configuration/">Configuration</a></li><li><a href="../credential-storage/">Credential storage</a></li><li><a href="../troubleshooting/">Troubleshooting</a></li></ul>
     </details>
   </nav>
   <main id="main">
@@ -145,6 +145,8 @@ <h3 id="exit-codes">Exit codes</h3>
 </tbody>
 </table></div>
 <figure class="demo" data-demo="scripting"><noscript><img src="../demos/scripting.svg" alt="Without a terminal: errors, --json, exit codes and -F -"></noscript><figcaption>Without a terminal: errors, <code>--json</code>, exit codes and <code>-F -</code></figcaption></figure>
+<h3 id="read-data">Read data</h3>
+<p>A product's data is at <code>s3://ACCOUNT/PRODUCT/</code> on the data proxy (<code>--proxy-url</code>, <code>https://data.source.coop</code> by default). Public data needs no sign-in; <a href="https://docs.source.coop/data-proxy">Access Data</a> shows each tool's settings. Restricted data and writes need the credentials from <code>creds</code> (see <a href="../reading-data-with-aws-tools/">Reading data with AWS tools</a>).</p>
 <h3 id="use-the-api-without-signing-in">Use the API without signing in</h3>
 <p>If <code>SOURCE_TOKEN</code> is set, the CLI sends it to the API instead of the session's access token. Thus a script or CI job can use the API without <code>auth login</code>.</p>
 <h3 id="use-your-session-with-other-tools">Use your session with other tools</h3>

pr-preview/pr-98/scripts-and-ai-agents/index.html

@@ -64,7 +64,7 @@
   <main id="main">
 <h1 id="troubleshooting">Troubleshooting</h1>
 <p><strong><code>Your login has expired. Run 'source-coop auth login'.</code></strong> The session's refresh token expired or was revoked. Sign in again. <code>source-coop auth status</code> estimates when it expires.</p>
-<p><strong><code>Couldn't get new credentials (…). Run 'source-coop auth login'.</code></strong> <code>creds</code> could not renew a role's credentials. AWS tools show this message as their own error. The reason is in the brackets. Usually the session has expired, so sign in again.</p>
+<p><strong><code>Couldn't get new credentials (…). Run 'source-coop auth login'.</code></strong> <code>creds</code> could not renew a role's credentials. AWS tools show this message as their own error. The reason is in the brackets. Usually the session has expired, so sign in again. The message also says that public data needs no credentials (see <a href="https://docs.source.coop/data-proxy">Access Data</a>).</p>
 <p><strong>macOS asks for your keychain password.</strong> macOS asks the first time a new build reads the <code>source-coop-cli</code> keychain items, for example after an upgrade. Select <strong>Always Allow</strong> so that it does not ask again until the next upgrade.</p>
 <p><strong><code>AccessDenied</code> from AWS tools.</strong> The data proxy refused the request. To read a product that is not public, or to write to any product, you must be a member with a role that allows it. Writes have more conditions, in <a href="../uploading-data-with-aws-tools/">Uploading data</a>. Check your role with <code>source-coop member list ACCOUNT</code> (the organization) or <code>ACCOUNT/PRODUCT</code>.</p>
 <p><strong>Exit code 4 or 5.</strong> A command exits with 4 when you are not signed in or not allowed, and 5 when the record does not exist. With <code>--json</code>, the error on stderr gives the HTTP <code>status</code> and, if the API sent one, a <code>request_id</code>. See <a href="../scripts-and-ai-agents/#exit-codes">Exit codes</a>.</p>