Reduce documentation duplication by linking to AiiDAlab docs (#1228)

edan-bainglass · web-flow · commit f1775894183b · 2025-04-01T12:22:09.000+02:00
This PR replaces the section on local Docker installation of AiiDAlab with a link to the corresponding section in the AiiDAlab docs and adds a note regarding the different image.
diff --git a/docs/source/installation/access/container.rst b/docs/source/installation/access/container.rst
@@ -0,0 +1,15 @@
+=====================
+Local Docker Instance
+=====================
+
+.. note::
+
+   If you used another method to access AiiDAlab, you may proceed to :doc:`install the app </installation/install>`.
+
+We provide an AiiDAlab Docker image extension with the Quantum ESPRESSO app pre-installed and ready for use. The installation instructions are mostly identical to the general instructions available on the `AiiDAlab documentation <https://aiidalab.readthedocs.io/en/latest/usage/access/index.html>`_ page. You only need to **replace** ``aiidalab/full-stack`` **with** ``ghcr.io/aiidalab/qe`` **when referencing the image** to use.
+
+When complete (AiiDAlab is running in your browser), return here and proceed to :doc:`launch the app </installation/launch>`.
+
+.. note::
+
+   When using this method to access AiiDAlab, the app will be pre-installed in the container and ready for use. No need to visit the *install the app* page.
diff --git a/docs/source/installation/access/index.rst b/docs/source/installation/access/index.rst
@@ -9,55 +9,56 @@ Access AiiDAlab
 .. grid:: 1 1 1 2
    :gutter: 3
 
-   .. grid-item-card:: Materials Cloud AiiDAlab Server
+   .. grid-item-card:: Local Docker Instance
       :text-align: center
       :shadow: md
 
-      For researchers affiliated with Materials Cloud partners, log into the open AiiDAlab server hosted on the Materials Cloud.
+      Install Docker locally and run an instance of an AiiDAlab image *pre-configured** for the Quantum ESPRESSO app. No prior knowledge of Docker necessary!
 
       ++++
 
-      .. button-link:: https://aiidalab.materialscloud.org/hub/login
+      .. button-ref:: container
+         :ref-type: doc
          :click-parent:
          :expand:
          :color: primary
          :outline:
 
-         Launch the server
+         To the guide
 
-   .. grid-item-card:: Local Docker Instance
+   .. grid-item-card:: Virtual Machine Image
       :text-align: center
       :shadow: md
 
-      Install Docker locally and run an instance of an AiiDAlab image *pre-configured** for the Quantum ESPRESSO app. No prior knowledge of Docker necessary!
+      Download a virtual machine image for AiiDAlab based on Quantum Mobile, *pre-configured** with everything you need to run the Quantum ESPRESSO app.
 
       ++++
 
-      .. button-ref:: container
+      .. button-ref:: vm
          :ref-type: doc
          :click-parent:
          :expand:
          :color: primary
          :outline:
 
-         To the guide
+         To the download page
 
-   .. grid-item-card:: Virtual Machine Image
+
+   .. grid-item-card:: Materials Cloud AiiDAlab Server
       :text-align: center
       :shadow: md
 
-      Download a virtual machine image for AiiDAlab based on Quantum Mobile, *pre-configured** with everything you need to run the Quantum ESPRESSO app.
+      For researchers affiliated with Materials Cloud partners, log into the open AiiDAlab server hosted on the Materials Cloud.
 
       ++++
 
-      .. button-ref:: vm
-         :ref-type: doc
+      .. button-link:: https://aiidalab.materialscloud.org/hub/login
          :click-parent:
          :expand:
          :color: primary
          :outline:
 
-         To the download page
+         Launch the server
 
 .. div::
 
diff --git a/docs/source/installation/access/vm.rst b/docs/source/installation/access/vm.rst
diff --git a/docs/source/installation/access_aiidalab/container.rst b/docs/source/installation/access_aiidalab/container.rst
diff --git a/docs/source/installation/index.rst b/docs/source/installation/index.rst
@@ -7,6 +7,6 @@ The following links will guide you through the necessary steps to access the Aii
 .. toctree::
    :maxdepth: 1
 
-   access_aiidalab/index
+   access/index
    install
    launch
diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst
@@ -5,7 +5,7 @@ Tutorials
 
 .. important::
 
-    Before you get started, make sure you've :doc:`accessed </installation/access_aiidalab/index>` AiiDAlab and :doc:`installed </installation/install>` the Quantum ESPRESSO app.
+    Before you get started, make sure you've :doc:`accessed </installation/access/index>` AiiDAlab and :doc:`installed </installation/install>` the Quantum ESPRESSO app.
 
 .. grid:: 1 1 1 2
    :gutter: 3
