From f8f6f226e9c5d74a2306b25df751018ab354cde0 Mon Sep 17 00:00:00 2001
From: Brett Smith <brett.smith@curii.com>
Date: Tue, 11 Jun 2024 11:10:13 -0400
Subject: [PATCH] 21572: Refactor repository setup docs into includes

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>
---
 doc/_includes/_setup_debian_repo.liquid   | 22 +++++++++++++++++
 doc/_includes/_setup_redhat_repo.liquid   | 18 ++++++++++++++
 doc/install/automatic.html.textile.liquid | 29 +++++++++++++---------
 doc/install/packages.html.textile.liquid  | 30 ++---------------------
 4 files changed, 59 insertions(+), 40 deletions(-)
 create mode 100644 doc/_includes/_setup_debian_repo.liquid
 create mode 100644 doc/_includes/_setup_redhat_repo.liquid

diff --git a/doc/_includes/_setup_debian_repo.liquid b/doc/_includes/_setup_debian_repo.liquid
new file mode 100644
index 0000000000..2f39bbca68
--- /dev/null
+++ b/doc/_includes/_setup_debian_repo.liquid
@@ -0,0 +1,22 @@
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+
+Set up the Arvados package repository by running these commands:
+
+<notextile>
+<pre><code># <span class="userinput">install -d /etc/apt/keyrings</span>
+# <span class="userinput">curl -fsSL -o /etc/apt/keyrings/arvados.asc https://apt.arvados.org/pubkey.gpg</span>
+# <span class="userinput">declare $(grep "^VERSION_CODENAME=" /etc/os-release || echo VERSION_CODENAME=MISSING)</span>
+# <span class="userinput">tee /etc/apt/sources.list.d/arvados.sources &gt;/dev/null &lt;&lt;EOF
+Types: deb
+URIs: https://apt.arvados.org/$VERSION_CODENAME
+Suites: $VERSION_CODENAME
+Components: main
+Signed-by: /etc/apt/keyrings/arvados.asc
+EOF</span>
+# <span class="userinput">apt update</span>
+</code></pre>
+</notextile>
diff --git a/doc/_includes/_setup_redhat_repo.liquid b/doc/_includes/_setup_redhat_repo.liquid
new file mode 100644
index 0000000000..ddff5a4b43
--- /dev/null
+++ b/doc/_includes/_setup_redhat_repo.liquid
@@ -0,0 +1,18 @@
+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}
+
+Set up the Arvados package repository by running these commands:
+
+<notextile>
+<pre><code># <span class="userinput">tee /etc/yum.repos.d/arvados.repo &gt;/dev/null &lt;&lt;'EOF'
+[arvados]
+name=Arvados
+baseurl=http://rpm.arvados.org/CentOS/$releasever/os/$basearch/
+gpgcheck=1
+gpgkey=http://rpm.arvados.org/CentOS/RPM-GPG-KEY-arvados
+EOF
+</span></code></pre>
+</notextile>
diff --git a/doc/install/automatic.html.textile.liquid b/doc/install/automatic.html.textile.liquid
index 48f73338cc..94feb0dc3a 100644
--- a/doc/install/automatic.html.textile.liquid
+++ b/doc/install/automatic.html.textile.liquid
@@ -49,26 +49,31 @@ Arvados needs a login backend. To get started quickly, add a user account on you
 
 h2. Initialize the cluster
 
-<pre>
-# echo > /etc/apt/sources.list.d/arvados.list "deb http://apt.arvados.org/$(lsb_release -sc) $(lsb_release -sc) main"
-# apt update
-# apt install arvados-server-easy
-# arvados-server init -cluster-id x9999 -domain x9999.example.com -tls acme -login pam
-</pre>
+{% include 'setup_debian_repo' %}
+
+Then install and run @arvados-server-easy@:
+
+<notextile>
+<pre><code># <span class="userinput">apt install arvados-server-easy</span>
+# <span class="userinput">arvados-server init -cluster-id x9999 -domain x9999.example.com -tls acme -login pam</span>
+</code></pre>
+</notextile>
 
 When the "init" command is finished, navigate to the link shown in the terminal (e.g., @https://x9999.example.com/@) and log in with the account you created above.
 
 Activate your new Arvados user account. Copy the UUID (looks like @x9999-tpzed-xxxxxxxxxxxxxxx@) from your browser's location bar and run:
 
-<pre>
-# arv sudo user setup --uuid x9999-tpzed-xxxxxxxxxxxxxxx
-</pre>
+<notextile>
+<pre><code># <span class="userinput">arv sudo user setup --uuid x9999-tpzed-xxxxxxxxxxxxxxx</span>
+</code></pre>
+</notextile>
 
 Run the diagnostics tool to ensure everything is working.
 
-<pre>
-# arv sudo diagnostics
-</pre>
+<notextile>
+<pre><code># <span class="userinput">arv sudo diagnostics</span>
+</code></pre>
+</notextile>
 
 h2. Customize the cluster
 
diff --git a/doc/install/packages.html.textile.liquid b/doc/install/packages.html.textile.liquid
index 59b12509f7..b541212e4f 100644
--- a/doc/install/packages.html.textile.liquid
+++ b/doc/install/packages.html.textile.liquid
@@ -26,18 +26,7 @@ Packages are available for the following Red Hat-based distributions:
 * RHEL 8
 * Rocky Linux 8
 
-Set up the Arvados package repository by running these commands:
-
-<notextile>
-<pre><code># <span class="userinput">tee /etc/yum.repos.d/arvados.repo &gt;/dev/null &lt;&lt;'EOF'
-[arvados]
-name=Arvados
-baseurl=http://rpm.arvados.org/CentOS/$releasever/os/$basearch/
-gpgcheck=1
-gpgkey=http://rpm.arvados.org/CentOS/RPM-GPG-KEY-arvados
-EOF
-</span></code></pre>
-</notextile>
+{% include 'setup_redhat_repo' %}
 
 h3(#debian). Debian and Ubuntu
 
@@ -48,19 +37,4 @@ Packages are available for the following Debian-based distributions:
 * Ubuntu 22.04 ("jammy")
 * Ubuntu 20.04 ("focal")
 
-Set up the Arvados package repository by running these commands:
-
-<notextile>
-<pre><code># <span class="userinput">install -d /etc/apt/keyrings</span>
-# <span class="userinput">curl -fsSL -o /etc/apt/keyrings/arvados.asc https://apt.arvados.org/pubkey.gpg</span>
-# <span class="userinput">declare "$(grep "^VERSION_CODENAME=" /etc/os-release || echo VERSION_CODENAME=MISSING)"</span>
-# <span class="userinput">tee /etc/apt/sources.list.d/arvados.sources &gt;/dev/null &lt;&lt;EOF
-Types: deb
-URIs: https://apt.arvados.org/$VERSION_CODENAME
-Suites: $VERSION_CODENAME
-Components: main
-Signed-by: /etc/apt/keyrings/arvados.asc
-EOF</span>
-# <span class="userinput">apt update</span>
-</code></pre>
-</notextile>
+{% include 'setup_debian_repo' %}
-- 
2.30.2