Skip to content

Commit

Permalink
Update main docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Sep 30, 2024
1 parent c6a0a49 commit cd37f08
Show file tree
Hide file tree
Showing 9 changed files with 29 additions and 34 deletions.
21 changes: 9 additions & 12 deletions static/docs/main/_sources/contents/installation.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ Rocky Linux 8

.. code-block:: console
# dnf install https://github.com/warewulf/warewulf/releases/download/v4.5.7/warewulf-4.5.7-1.el8.x86_64.rpm
# dnf install https://github.com/warewulf/warewulf/releases/download/v4.5.8/warewulf-4.5.8-1.el8.x86_64.rpm
openSuse Leap
-------------

.. code-block:: console
# zypper install https://github.com/warewulf/warewulf/releases/download/v4.5.7/warewulf-4.5.7-1.suse.lp155.x86_64.rpm
# zypper install https://github.com/warewulf/warewulf/releases/download/v4.5.8/warewulf-4.5.8-1.suse.lp155.x86_64.rpm
Compiled Source code
====================
Expand Down Expand Up @@ -59,9 +59,9 @@ appropriate substitutions:

.. code-block:: bash
curl -LO https://github.com/warewulf/warewulf/releases/download/v4.5.7/warewulf-4.5.7.tar.gz
tar -xf warewulf-4.5.7.tar.gz
cd warewulf-4.5.7
curl -LO https://github.com/warewulf/warewulf/releases/download/v4.5.8/warewulf-4.5.8.tar.gz
tar -xf warewulf-4.5.8.tar.gz
cd warewulf-4.5.8
make all && sudo make install
Git
Expand All @@ -71,16 +71,13 @@ Warewulf is developed in GitHub, a source code management platform
that allows collaborative development and revision control. From the
Git repository, you can download different versions of the project
either from tags or branches. By default, when you go to the GitHub
page, you will find the default branch entitled ``development``. The
``development`` branch is where most of the active development occurs,
page, you will find the default branch entitled ``main``. The
``main`` branch is where most of the active development occurs,
so if you want to obtain the latest and greatest version of Warewulf,
this is where to go. But be forewarned, using a snapshot from
``development`` is not guaranteed to be stable or generally supported
``main`` is not guaranteed to be stable or generally supported
for production.

Alternatively, the ``main`` branch is more stable and is used as a
staging area for pending releases.

If you are building for production, it is best to download a release
tarball from the main site, the GitHub releases page, or from a Git
tag.
Expand All @@ -89,7 +86,7 @@ tag.
git clone https://github.com/warewulf/warewulf.git
cd warewulf
git checkout development # or switch to a tag like 'v4.5.7'
git checkout main # or switch to a tag like 'v4.5.8'
make all && sudo make install
Runtime Dependencies
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Vagrantfile
cat << 'EOF' > Vagrantfile
Vagrant.configure("2") do |config|
number_of_node = ENV["NODES"] || 2
branch = ENV["BRANCH"] || "v4.5.7"
branch = ENV["BRANCH"] || "v4.5.8"
config.vm.define :head do |head|
head.vm.box = "rockylinux/9"
Expand Down Expand Up @@ -161,7 +161,7 @@ Vagrantfile
cd /tmp
git clone https://github.com/warewulf/warewulf.git
cd warewulf
git checkout v4.5.7
git checkout v4.5.8
make clean defaults \
PREFIX=/usr \
BINDIR=/usr/bin \
Expand Down
2 changes: 1 addition & 1 deletion static/docs/main/_sources/quickstart/debian12.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Install Warewulf and dependencies
cd ~/git
git clone https://github.com/warewulf/warewulf.git
cd warewulf
git checkout main # or switch to a tag like 'v4.5.7'
git checkout main # or switch to a tag like 'v4.5.8'
make all && sudo make install
Expand Down
4 changes: 2 additions & 2 deletions static/docs/main/_sources/quickstart/el.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ Install Warewulf

The preferred way to install Warewulf on Enterprise Linux is using the
the RPMs published in `GitHub releases`_. For example, to install the
v4.5.7 release on Enterprise Linux 9:
v4.5.8 release on Enterprise Linux 9:

.. code-block:: bash
dnf install https://github.com/warewulf/warewulf/releases/download/v4.5.7/warewulf-4.5.7-1.el9.x86_64.rpm
dnf install https://github.com/warewulf/warewulf/releases/download/v4.5.8/warewulf-4.5.8-1.el9.x86_64.rpm
Packages are available for el8 and el9.

Expand Down
20 changes: 9 additions & 11 deletions static/docs/main/contents/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,13 +135,13 @@ <h2>Binary RPMs<a class="headerlink" href="#binary-rpms" title="Link to this hea
process. You can obtain them from the <a class="reference external" href="https://github.com/warewulf/warewulf/releases">GitHub releases</a> page.</p>
<section id="rocky-linux-8">
<h3>Rocky Linux 8<a class="headerlink" href="#rocky-linux-8" title="Link to this heading"></a></h3>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>dnf<span class="w"> </span>install<span class="w"> </span>https://github.com/warewulf/warewulf/releases/download/v4.5.7/warewulf-4.5.7-1.el8.x86_64.rpm
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>dnf<span class="w"> </span>install<span class="w"> </span>https://github.com/warewulf/warewulf/releases/download/v4.5.8/warewulf-4.5.8-1.el8.x86_64.rpm
</pre></div>
</div>
</section>
<section id="opensuse-leap">
<h3>openSuse Leap<a class="headerlink" href="#opensuse-leap" title="Link to this heading"></a></h3>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>zypper<span class="w"> </span>install<span class="w"> </span>https://github.com/warewulf/warewulf/releases/download/v4.5.7/warewulf-4.5.7-1.suse.lp155.x86_64.rpm
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp"># </span>zypper<span class="w"> </span>install<span class="w"> </span>https://github.com/warewulf/warewulf/releases/download/v4.5.8/warewulf-4.5.8-1.suse.lp155.x86_64.rpm
</pre></div>
</div>
</section>
Expand Down Expand Up @@ -170,9 +170,9 @@ <h3>Release Tarball<a class="headerlink" href="#release-tarball" title="Link to
<p>Select the version you wish to install and download the tarball to any
location on the server, then follow these directions making the
appropriate substitutions:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-LO<span class="w"> </span>https://github.com/warewulf/warewulf/releases/download/v4.5.7/warewulf-4.5.7.tar.gz
tar<span class="w"> </span>-xf<span class="w"> </span>warewulf-4.5.7.tar.gz
<span class="nb">cd</span><span class="w"> </span>warewulf-4.5.7
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>curl<span class="w"> </span>-LO<span class="w"> </span>https://github.com/warewulf/warewulf/releases/download/v4.5.8/warewulf-4.5.8.tar.gz
tar<span class="w"> </span>-xf<span class="w"> </span>warewulf-4.5.8.tar.gz
<span class="nb">cd</span><span class="w"> </span>warewulf-4.5.8
make<span class="w"> </span>all<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>sudo<span class="w"> </span>make<span class="w"> </span>install
</pre></div>
</div>
Expand All @@ -183,20 +183,18 @@ <h3>Git<a class="headerlink" href="#git" title="Link to this heading"></a></h
that allows collaborative development and revision control. From the
Git repository, you can download different versions of the project
either from tags or branches. By default, when you go to the GitHub
page, you will find the default branch entitled <code class="docutils literal notranslate"><span class="pre">development</span></code>. The
<code class="docutils literal notranslate"><span class="pre">development</span></code> branch is where most of the active development occurs,
page, you will find the default branch entitled <code class="docutils literal notranslate"><span class="pre">main</span></code>. The
<code class="docutils literal notranslate"><span class="pre">main</span></code> branch is where most of the active development occurs,
so if you want to obtain the latest and greatest version of Warewulf,
this is where to go. But be forewarned, using a snapshot from
<code class="docutils literal notranslate"><span class="pre">development</span></code> is not guaranteed to be stable or generally supported
<code class="docutils literal notranslate"><span class="pre">main</span></code> is not guaranteed to be stable or generally supported
for production.</p>
<p>Alternatively, the <code class="docutils literal notranslate"><span class="pre">main</span></code> branch is more stable and is used as a
staging area for pending releases.</p>
<p>If you are building for production, it is best to download a release
tarball from the main site, the GitHub releases page, or from a Git
tag.</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/warewulf/warewulf.git
<span class="nb">cd</span><span class="w"> </span>warewulf
git<span class="w"> </span>checkout<span class="w"> </span>development<span class="w"> </span><span class="c1"># or switch to a tag like &#39;v4.5.7&#39;</span>
git<span class="w"> </span>checkout<span class="w"> </span>main<span class="w"> </span><span class="c1"># or switch to a tag like &#39;v4.5.8&#39;</span>
make<span class="w"> </span>all<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>sudo<span class="w"> </span>make<span class="w"> </span>install
</pre></div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ <h3>Vagrantfile<a class="headerlink" href="#vagrantfile" title="Link to this hea
cat<span class="w"> </span><span class="s">&lt;&lt; &#39;EOF&#39; &gt; Vagrantfile</span>
<span class="s">Vagrant.configure(&quot;2&quot;) do |config|</span>
<span class="s"> number_of_node = ENV[&quot;NODES&quot;] || 2</span>
<span class="s"> branch = ENV[&quot;BRANCH&quot;] || &quot;v4.5.7&quot;</span>
<span class="s"> branch = ENV[&quot;BRANCH&quot;] || &quot;v4.5.8&quot;</span>

<span class="s"> config.vm.define :head do |head|</span>
<span class="s"> head.vm.box = &quot;rockylinux/9&quot;</span>
Expand Down Expand Up @@ -274,7 +274,7 @@ <h3>Vagrantfile<a class="headerlink" href="#vagrantfile" title="Link to this hea
<span class="s"> cd /tmp</span>
<span class="s"> git clone https://github.com/warewulf/warewulf.git</span>
<span class="s"> cd warewulf</span>
<span class="s"> git checkout v4.5.7</span>
<span class="s"> git checkout v4.5.8</span>
<span class="s"> make clean defaults \</span>
<span class="s"> PREFIX=/usr \</span>
<span class="s"> BINDIR=/usr/bin \</span>
Expand Down
2 changes: 1 addition & 1 deletion static/docs/main/quickstart/debian12.html
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ <h2>Install Warewulf and dependencies<a class="headerlink" href="#install-warewu
<span class="nb">cd</span><span class="w"> </span>~/git
git<span class="w"> </span>clone<span class="w"> </span>https://github.com/warewulf/warewulf.git
<span class="nb">cd</span><span class="w"> </span>warewulf
git<span class="w"> </span>checkout<span class="w"> </span>main<span class="w"> </span><span class="c1"># or switch to a tag like &#39;v4.5.7&#39;</span>
git<span class="w"> </span>checkout<span class="w"> </span>main<span class="w"> </span><span class="c1"># or switch to a tag like &#39;v4.5.8&#39;</span>
make<span class="w"> </span>all<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>sudo<span class="w"> </span>make<span class="w"> </span>install
</pre></div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions static/docs/main/quickstart/el.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,8 +133,8 @@ <h1>Enterprise Linux Quickstart (Rocky Linux, CentOS, and RHEL)<a class="headerl
<h2>Install Warewulf<a class="headerlink" href="#install-warewulf" title="Link to this heading"></a></h2>
<p>The preferred way to install Warewulf on Enterprise Linux is using the
the RPMs published in <a class="reference external" href="https://github.com/warewulf/warewulf/releases">GitHub releases</a>. For example, to install the
v4.5.7 release on Enterprise Linux 9:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>dnf<span class="w"> </span>install<span class="w"> </span>https://github.com/warewulf/warewulf/releases/download/v4.5.7/warewulf-4.5.7-1.el9.x86_64.rpm
v4.5.8 release on Enterprise Linux 9:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>dnf<span class="w"> </span>install<span class="w"> </span>https://github.com/warewulf/warewulf/releases/download/v4.5.8/warewulf-4.5.8-1.el9.x86_64.rpm
</pre></div>
</div>
<p>Packages are available for el8 and el9.</p>
Expand Down
2 changes: 1 addition & 1 deletion static/docs/main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit cd37f08

Please sign in to comment.