Skip to content

Commit a5d604d

Browse files
authored
Merge pull request #5542 from kenjis/fix-docs-upgrade-instruction
docs: improve upgrade instructions
2 parents e0fd7d4 + 3f18412 commit a5d604d

File tree

3 files changed

+19
-10
lines changed

3 files changed

+19
-10
lines changed

user_guide_src/source/installation/installing_composer.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ A sample such installation command, using the default project-root "appstarter":
5050

5151
After installation you should follow the steps in the "Upgrading" section.
5252

53+
.. _app-starter-upgrading:
54+
5355
Upgrading
5456
---------
5557

@@ -68,7 +70,7 @@ If ``--prefer-source`` doesn't automatically update to pull latest framework sou
6870
If you used the ``--no-dev`` option when you created the project, it
6971
would be appropriate to do so here too, i.e., ``composer update --no-dev``.
7072

71-
Read the upgrade instructions, and check designated ``app/Config`` folders for affected changes.
73+
Read the :doc:`upgrade instructions <upgrading>`, and check Breaking Changes and Enhancements.
7274

7375
Pros
7476
----
@@ -142,15 +144,16 @@ Copy the ``env``, ``phpunit.xml.dist`` and ``spark`` files, from
142144
You will have to adjust the system path to refer to the vendor one, e.g., ``ROOTPATH . '/vendor/codeigniter4/framework/system'``,
143145
- the ``$systemDirectory`` variable in **app/Config/Paths.php**
144146

147+
.. _adding-codeigniter4-upgrading:
148+
145149
Upgrading
146150
---------
147151

148152
Whenever there is a new release, then from the command line in your project root::
149153

150154
> composer update --prefer-source
151155

152-
Read the upgrade instructions, and check designated
153-
``app/Config`` folders for affected changes.
156+
Read the :doc:`upgrade instructions <upgrading>`, and check Breaking Changes and Enhancements.
154157

155158
Pros
156159
----

user_guide_src/source/installation/installing_manual.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@ Setting Up
2727

2828
None
2929

30+
.. _installing-manual-upgrading:
31+
3032
Upgrading
3133
---------
3234

33-
Download a new copy of the framework, and then follow the upgrade
34-
instructions in the release notice or changelog to merge that with your project.
35+
Download a new copy of the framework, and then replace the ``system`` folder.
3536

36-
Typically, you replace the ``system`` folder, and check designated
37-
``app/Config`` folders for affected changes.
37+
Read the :doc:`upgrade instructions <upgrading>`, and check Breaking Changes and Enhancements.
3838

3939
Pros
4040
----

user_guide_src/source/installation/upgrade_416.rst

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
Upgrading from 4.1.5 to 4.1.6
33
#############################
44

5+
Please refer to the upgrade instructions corresponding to your installation method.
6+
7+
- :ref:`Composer Installation App Starter Upgrading <app-starter-upgrading>`
8+
- :ref:`Composer Installation Adding CodeIgniter4 to an Existing Project Upgrading <adding-codeigniter4-upgrading>`
9+
- :ref:`Manual Installation Upgrading <installing-manual-upgrading>`
10+
511
.. contents::
612
:local:
713
:depth: 2
@@ -22,8 +28,8 @@ none.
2228
Project Files
2329
*************
2430

25-
Numerous files in the project space (root, app, public, writable) received updates. Due to
26-
these files being outside of the system scope they will not be changed without your intervention.
31+
Numerous files in the **project space** (root, app, public, writable) received updates. Due to
32+
these files being outside of the **system** scope they will not be changed without your intervention.
2733
There are some third-party CodeIgniter modules available to assist with merging changes to
2834
the project space: `Explore on Packagist <https://packagist.org/explore/?query=codeigniter4%20updates>`_.
2935

@@ -45,7 +51,7 @@ and it is recommended that you merge the updated versions with your application:
4551
All Changes
4652
===========
4753

48-
This is a list of all files in the project space that received changes;
54+
This is a list of all files in the **project space** that received changes;
4955
many will be simple comments or formatting that have no effect on the runtime:
5056

5157
* ``app/Config/Filters.php``

0 commit comments

Comments
 (0)