Skip to content

Commit

Permalink
Update main userdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 11, 2024
1 parent a443b59 commit a9285b5
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 7 deletions.
4 changes: 2 additions & 2 deletions public/docs/user/main/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ This guide aims to give an introduction to {Project}, brief
installation instructions, and cover topics relevant to users building
and running containers.

For a detailed guide to installation and configuration, please see the
separate `Admin Guide <{admindocs}>`_ for this version of {Project}.
For a detailed guide to installation and configuration, as well as upgrading or
uninstalling, please see the separate `Admin Guide <{admindocs}>`_ for this version of {Project}.

****************************************
Getting Started & Background Information
Expand Down
5 changes: 4 additions & 1 deletion public/docs/user/main/_sources/quick_start.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ and using {Project} on Mac and Windows machines
are discussed in the `installation section of the admin guide
<{admindocs}/installation.html>`__.

If you have an existing version of {Project} installed from source, which
you wish to upgrade or remove / uninstall, also see the `installation section of the admin guide
<{admindocs}/installation.html>`__.

***************************************
Overview of the {Project} Interface
***************************************
Expand Down Expand Up @@ -138,7 +142,6 @@ Information about individual subcommands can also be viewed by using the
Examples:
$ {command} verify container.sif
For additional help or support, please visit https://www.apptainer.org/docs/
{Project} uses positional syntax (i.e. the order of commands and options
Expand Down
4 changes: 2 additions & 2 deletions public/docs/user/main/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,8 @@ <h1>Apptainer User Guide<a class="headerlink" href="#apptainer-user-guide" title
<p>This guide aims to give an introduction to Apptainer, brief
installation instructions, and cover topics relevant to users building
and running containers.</p>
<p>For a detailed guide to installation and configuration, please see the
separate <a class="reference external" href="https://apptainer.org/docs/admin/main">Admin Guide</a> for this version of Apptainer.</p>
<p>For a detailed guide to installation and configuration, as well as upgrading or
uninstalling, please see the separate <a class="reference external" href="https://apptainer.org/docs/admin/main">Admin Guide</a> for this version of Apptainer.</p>
<div class="section" id="getting-started-background-information">
<h2>Getting Started &amp; Background Information<a class="headerlink" href="#getting-started-background-information" title="Permalink to this heading"></a></h2>
<div class="toctree-wrapper compound">
Expand Down
3 changes: 2 additions & 1 deletion public/docs/user/main/quick_start.html
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,8 @@
installing Apptainer without root privileges,
and using Apptainer on Mac and Windows machines
are discussed in the <a class="reference external" href="https://apptainer.org/docs/admin/main/installation.html">installation section of the admin guide</a>.</p>
<p>If you have an existing version of Apptainer installed from source, which
you wish to upgrade or remove / uninstall, also see the <a class="reference external" href="https://apptainer.org/docs/admin/main/installation.html">installation section of the admin guide</a>.</p>
</div>
<div class="section" id="overview-of-the-apptainer-interface">
<h2>Overview of the Apptainer Interface<a class="headerlink" href="#overview-of-the-apptainer-interface" title="Permalink to this heading"></a></h2>
Expand Down Expand Up @@ -263,7 +265,6 @@ <h2>Overview of the Apptainer Interface<a class="headerlink" href="#overview-of-
Examples:
$ apptainer verify container.sif


For additional help or support, please visit https://www.apptainer.org/docs/
</pre></div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion public/docs/user/main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit a9285b5

Please sign in to comment.