Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve upgrade instructions #5542

Merged
merged 3 commits into from
Jan 5, 2022
Merged

docs: improve upgrade instructions #5542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3147214
docs: improve upgrade instructions
kenjis Jan 5, 2022
d0b0df4
docs: fix manual installation upgrading instruction
kenjis Jan 5, 2022
3f18412
docs: fix upgrade instructions
kenjis Jan 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions user_guide_src/source/installation/installing_composer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ A sample such installation command, using the default project-root "appstarter":

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

.. _app-starter-upgrading:

Upgrading
---------

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

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

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

.. _adding-codeigniter4-upgrading:

Upgrading
---------

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

> composer update --prefer-source

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

Pros
----
Expand Down
8 changes: 4 additions & 4 deletions user_guide_src/source/installation/installing_manual.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ Setting Up

None

.. _installing-manual-upgrading:

Upgrading
---------

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

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

Pros
----
Expand Down
12 changes: 9 additions & 3 deletions user_guide_src/source/installation/upgrade_416.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
Upgrading from 4.1.5 to 4.1.6
#############################

Please refer to the upgrade instructions corresponding to your installation method.

- :ref:`Composer Installation App Starter Upgrading <app-starter-upgrading>`
- :ref:`Composer Installation Adding CodeIgniter4 to an Existing Project Upgrading <adding-codeigniter4-upgrading>`
- :ref:`Manual Installation Upgrading <installing-manual-upgrading>`

.. contents::
:local:
:depth: 2
Expand All @@ -22,8 +28,8 @@ none.
Project Files
*************

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

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

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

* ``app/Config/Filters.php``
Expand Down