Skip to content

Commit 2a22624

Browse files
GOATS-1021: Update the user documentation to properly place the `Upda… (#507)
* GOATS-1021: Update the user documentation to properly place the `Updating` section * Add towncrier entry.
1 parent a0f1b0a commit 2a22624

4 files changed

Lines changed: 20 additions & 11 deletions

File tree

docs/changes/507.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Reorganized the user documentation to correctly place the “Updating” section.

docs/readthedocs/source/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ GOATS relies on the following components -
4848
:caption: Table of Contents
4949

5050
installation.rst
51-
updating.rst
5251
overview.rst
5352
functionalities.rst
5453
acknowledgment.rst

docs/readthedocs/source/installation.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,4 +199,8 @@ GOATS is actively developed and regularly updated. When a new version is availab
199199
See :ref:`updating` for full instructions on how to update GOATS safely and correctly.
200200

201201

202+
.. toctree::
203+
:maxdepth: 1
204+
:hidden:
202205

206+
updating.rst

docs/readthedocs/source/updating.rst

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _updating:
22

3-
Updating
4-
========
3+
Updating GOATS
4+
==============
55

66
This guide explains how to update GOATS to the latest version.
77
The update process is simple and takes just a few minutes.
@@ -49,17 +49,22 @@ Automatic Version Check
4949
GOATS checks for newer versions every time you run ``goats run``. If your version is outdated, a warning like the following will appear:
5050

5151
.. code-block:: text
52+
53+
WARNING: A new version of GOATS is available: 25.11.3 (current: 25.11.0)
54+
GOATS interacts with several external services (e.g., GPP, GOA, TNS)
55+
which may evolve over time. Using an outdated version can result in
56+
unexpected behavior or failed operations due to API changes or
57+
incompatible features.
5258
53-
A new version of GOATS is available: 25.11.0 (current: 25.10.1)
59+
Update steps:
60+
• Stop GOATS
61+
• Run: conda update goats
62+
• Start GOATS again
5463
55-
GOATS interacts with several external services (e.g., GPP, GOA, TNS)
56-
which may evolve over time. Using an outdated version can result in
57-
unexpected behavior or failed operations due to API changes or
58-
incompatible features.
64+
➤ For more details, visit https://goats.readthedocs.io/en/stable/updating.html
5965
60-
➤ Visit https://goats.readthedocs.io/en/stable/updating.html for update instructions
66+
Press Enter to continue at your own risk, or Ctrl+C to cancel...
6167
62-
Press Enter to continue at your own risk, or Ctrl+C to cancel...
6368
6469
If your version is current, GOATS will confirm:
6570

@@ -76,4 +81,4 @@ After restarting, verify the update with:
7681
7782
goats --version
7883
79-
You should see the updated version number displayed.
84+
You should see the updated version number displayed.

0 commit comments

Comments
 (0)