Rebuild iko docs

Author: bcb

iko/commands/index.html

@@ -1025,11 +1025,17 @@
 
 
 <h1 id="commands">Commands</h1>
+<p>Iko provides a command-line interface for generating and managing Sqitch-based
+migrations.</p>
+<p>This page is a reference for all available commands.</p>
 <h2 id="sqitch-commands">Sqitch commands</h2>
 <p>Iko aliases all of <a href="https://sqitch.org/docs/manual/">Sqitch's commands</a>.</p>
+<p>For example, <code>sqitch check</code> becomes <code>iko check</code>.</p>
 <p>You can also access <code>sqitch</code> directly, for example:</p>
 <div class="highlight"><pre><span></span><code>iko<span class="w"> </span>sqitch<span class="w"> </span>--version
 </code></pre></div>
+<p>When scripting, the <code>iko</code> part is left out. For example, <code>iko create_schema api</code> becomes simply <code>create_schema api</code>. In this document the <code>iko</code> command is
+left out.</p>
 <h2 id="ad-hoc-migrations">Ad-hoc migrations</h2>
 <blockquote>
 <p>📖 Refer to <a href="https://sqitch.org/docs/manual/sqitch-add/">sqitch-add</a>.</p>

iko/deploying/index.html

@@ -628,18 +628,21 @@
 
 <h1 id="deploying-migrations-to-remote-environments">🚀 Deploying Migrations to Remote Environments</h1>
 <p>Iko runs inside a container, so to deploy migrations to a remote environment
-(like staging or production), you’ll need to include your migration scripts
-inside a custom Docker image.</p>
+(like staging or production), build a custom Docker image containing your
+migration scripts.</p>
 <p>This guide explains how to build and use that image.</p>
 <hr />
 <h2 id="why-use-a-custom-image">✅ Why use a custom image?</h2>
-<p>The standard Iko CLI uses <code>docker run</code> with a local <code>migrations/</code> directory mounted into the container. This works great locally, but in remote environments:</p>
+<p>The standard Iko CLI uses <code>docker run</code> with a local <code>migrations/</code> directory
+mounted into the container. This works great locally, but in remote
+environments:</p>
 <ul>
 <li>There's no local <code>migrations/</code> directory to mount.</li>
 <li>There’s no Git repository cloned.</li>
 <li>You want repeatable, portable deploys — not manual file copying.</li>
 </ul>
-<p>By building a Docker image that <em>includes</em> your migrations, you ensure the container is fully self-contained and deployable anywhere.</p>
+<p>By building a Docker image that <em>includes</em> your migrations, you ensure the
+container is fully self-contained and deployable anywhere.</p>
 <hr />
 <h2 id="step-by-step-build-and-deploy">🧱 Step-by-Step: Build and Deploy</h2>
 <h3 id="1-create-a-dockerfile">1. Create a Dockerfile</h3>
@@ -650,10 +653,10 @@ <h3 id="1-create-a-dockerfile">1. Create a Dockerfile</h3>
 <p>This copies your migrations into the image at /repo, where Iko expects them.</p>
 <h3 id="2-build-the-image">2. Build the image</h3>
 <p>Give it a meaningful tag, e.g. for production:</p>
-<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>build<span class="w"> </span>-t<span class="w"> </span>ghcr.io/your-org/iko-with-migrations:latest<span class="w"> </span>.
+<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>build<span class="w"> </span>-t<span class="w"> </span>ghcr.io/&lt;org&gt;/iko-&lt;project&gt;:latest<span class="w"> </span>.
 </code></pre></div>
 <p>Then push it to your container registry:</p>
-<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>push<span class="w"> </span>ghcr.io/your-org/iko-with-migrations:latest
+<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>push<span class="w"> </span>ghcr.io/your-org/iko-&lt;project&gt;:latest
 </code></pre></div>
 <h3 id="3-set-the-target-connection">3. Set the target connection</h3>
 <p>Iko uses the <code>SQITCH_TARGET</code> environment variable to connect to your database.</p>
@@ -667,15 +670,14 @@ <h3 id="3-set-the-target-connection">3. Set the target connection</h3>
 </blockquote>
 <h3 id="4-run-the-deployment">4. Run the deployment</h3>
 <p>From your CI/CD pipeline or target server, run:</p>
-<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
-<span class="w">  </span>ghcr.io/your-org/iko-with-migrations:latest<span class="w"> </span>deploy<span class="w"> </span>--verify
+<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>ghcr.io/your-org/iko-your-project:latest<span class="w"> </span>deploy<span class="w"> </span>--verify
 </code></pre></div>
 <h4 id="do-i-need-network">🤔 Do I need --network?</h4>
 <p>Only if your Postgres instance is running in Docker on the same machine.</p>
 <p>If so, and it's in a custom Docker network, use:</p>
 <div class="highlight"><pre><span></span><code>docker<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span><span class="se">\</span>
 <span class="w"> </span>--network<span class="w"> </span>your-network<span class="w"> </span><span class="se">\</span>
-<span class="w"> </span>ghcr.io/your-org/iko-with-migrations:latest<span class="w"> </span>deploy<span class="w"> </span>--verify
+<span class="w"> </span>ghcr.io/your-org/iko-your-project:latest<span class="w"> </span>deploy<span class="w"> </span>--verify
 </code></pre></div>
 <p>Otherwise, for hosted databases (RDS, Cloud SQL, etc.) or Postgres installed on
 the host system, you don’t need a custom Docker network.</p>