Skip to content
This repository was archived by the owner on Aug 1, 2024. It is now read-only.

Commit f77842f

Browse files
authored
docs: Add a doc for manual upgrade instructions (#1183)
Seed the doc with most recent upgrade instructions (from Team Infinity at 2U).
1 parent 117770f commit f77842f

3 files changed

Lines changed: 22 additions & 0 deletions

File tree

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,5 @@ Contents
2626
pycharm_integration
2727
testing_and_debugging
2828
troubleshoot_general_tips
29+
manual_upgrades
2930
advanced_configuration

docs/manual_upgrades.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Manual upgrade instructions
2+
###########################
3+
4+
Occasionally there is a change to devstack that requires existing devstack installations to be manually upgraded. When this happens, instructions should be added here.
5+
6+
Please add new instructions to the top, include a date, and make a post in the `Devstack forum <https://discuss.openedx.org/tags/c/development/11/devstack>`_.
7+
8+
(If you just need to update your devstack to the latest version of everything, see :doc:`updating_devstack`.)
9+
10+
2023-08-02 - Forum upgrade from Ruby 2 to 3
11+
*******************************************
12+
13+
The forum service has been upgraded from Ruby 2 to Ruby 3. Developers who use forum will need to pull the new image and reprovision the service::
14+
15+
make dev.pull.forum # pull in new forum image
16+
make dev.provision.forum # provision forum service

docs/troubleshoot_general_tips.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,11 @@ Like with pulling images, you can also narrow these commands to specific service
302302

303303
Running ``make dev.reset`` will do all the above for all services, which can be useful but takes much more time. It will also run a full ``docker system prune -f`` to get rid of unused images and networks.
304304

305+
Manual Upgrades
306+
===============
307+
308+
Sometimes there is a change to devstack that requires existing devstack installations to be manually upgraded. See :doc:`manual_upgrades` for recent cases of this.
309+
305310
Starting From Scratch
306311
=====================
307312

0 commit comments

Comments
 (0)