From b63176ee0f51e9561a06b03f0f2e25c79d56e1b9 Mon Sep 17 00:00:00 2001 From: kenjis Date: Thu, 11 Apr 2024 11:02:31 +0900 Subject: [PATCH 1/6] docs: add links to change log --- user_guide_src/source/installation/installing_composer.rst | 6 ++++-- user_guide_src/source/installation/installing_manual.rst | 3 ++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/user_guide_src/source/installation/installing_composer.rst b/user_guide_src/source/installation/installing_composer.rst index 7096c3d6fb73..10cfaf6fc8ed 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -82,7 +82,8 @@ Whenever there is a new release, then from the command line in your project root composer update -Read the :doc:`upgrade instructions `, and check Breaking Changes and Enhancements. +Read the :doc:`upgrade instructions ` and :doc:`change log <../changelogs/index>`, +and check Breaking Changes and Enhancements. Pros ---- @@ -215,7 +216,8 @@ Whenever there is a new release, then from the command line in your project root composer update -Read the :doc:`upgrade instructions `, and check Breaking Changes and Enhancements. +Read the :doc:`upgrade instructions ` and :doc:`change log <../changelogs/index>`, +and check Breaking Changes and Enhancements. Pros ---- diff --git a/user_guide_src/source/installation/installing_manual.rst b/user_guide_src/source/installation/installing_manual.rst index 8b55e375de0b..150c42ee98a1 100644 --- a/user_guide_src/source/installation/installing_manual.rst +++ b/user_guide_src/source/installation/installing_manual.rst @@ -42,7 +42,8 @@ Upgrading Download a new copy of the framework, and then replace the **system** folder. -Read the :doc:`upgrade instructions `, and check Breaking Changes and Enhancements. +Read the :doc:`upgrade instructions ` and :doc:`change log <../changelogs/index>`, +and check Breaking Changes and Enhancements. Pros ==== From 91e0861f1d05fe92ad78d17af6e9453bc347f4cc Mon Sep 17 00:00:00 2001 From: kenjis Date: Thu, 11 Apr 2024 11:13:48 +0900 Subject: [PATCH 2/6] docs: add sub section "Upgrading to a Specified Version" --- .../installation/installing_composer.rst | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/user_guide_src/source/installation/installing_composer.rst b/user_guide_src/source/installation/installing_composer.rst index 10cfaf6fc8ed..2303011bb47f 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -85,6 +85,23 @@ Whenever there is a new release, then from the command line in your project root Read the :doc:`upgrade instructions ` and :doc:`change log <../changelogs/index>`, and check Breaking Changes and Enhancements. +Upgrading to a Specified Version +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +For example, you may want to upgrade to v4.4.8 after v4.5.0 has been released. + +In that case, open **composer.json** in your project root folder, and specify +the framework version: + +.. code-block:: text + + "require": { + ... + "codeigniter4/framework": "4.4.8" + }, + +Then, run the ``composer update`` command. + Pros ---- @@ -219,6 +236,23 @@ Whenever there is a new release, then from the command line in your project root Read the :doc:`upgrade instructions ` and :doc:`change log <../changelogs/index>`, and check Breaking Changes and Enhancements. +Upgrading to a Specified Version +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +For example, you may want to upgrade to v4.4.8 after v4.5.0 has been released. + +In that case, open **composer.json** in your project root folder, and specify +the framework version: + +.. code-block:: text + + "require": { + ... + "codeigniter4/framework": "4.4.8" + }, + +Then, run the ``composer update`` command. + Pros ---- From da8a486b9cb2b1b17945c010a408562caa72971f Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 12 Apr 2024 07:57:46 +0900 Subject: [PATCH 3/6] docs: fix by proofreading Co-authored-by: Michal Sniatala --- user_guide_src/source/installation/installing_composer.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user_guide_src/source/installation/installing_composer.rst b/user_guide_src/source/installation/installing_composer.rst index 2303011bb47f..eadbb3f72cde 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -88,7 +88,7 @@ and check Breaking Changes and Enhancements. Upgrading to a Specified Version ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -For example, you may want to upgrade to v4.4.8 after v4.5.0 has been released. +For example, you may want to upgrade from v4.4.7 to v4.4.8 after v4.5.0 has been released. In that case, open **composer.json** in your project root folder, and specify the framework version: From 42c8ad5224b7cdc4daa2849f2f962d306a2e181e Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 12 Apr 2024 08:13:42 +0900 Subject: [PATCH 4/6] docs: add section "Installing Previous Versions" and note --- .../installation/installing_composer.rst | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/user_guide_src/source/installation/installing_composer.rst b/user_guide_src/source/installation/installing_composer.rst index eadbb3f72cde..557f81e8d5b8 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -65,6 +65,35 @@ If you omit the "project-root" argument, the command will create an that are not needed in the production environment. This will greatly reduce the vendor folder size. +Installing Previous Versions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +For example, you may want to install v4.4.8 after v4.5.0 has been released. + +In that case, specify the version in the command: + +.. code-block:: console + + composer create-project codeigniter4/appstarter:4.4.8 project-root + +Then, open **composer.json** in your project root folder, and specify +the framework version: + +.. code-block:: text + + "require": { + ... + "codeigniter4/framework": "4.4.8" + }, + +Then, run the ``composer update`` command. + +.. note:: If you fix the version number like ``"codeigniter4/framework": "4.4.8"`` + in your **composer.json**, ``composer update`` command will not update the + framework. See `Writing Version Constraints`_ for how to specify the version. + +.. _Writing Version Constraints: https://getcomposer.org/doc/articles/versions.md#writing-version-constraints + Initial Configuration --------------------- @@ -102,6 +131,10 @@ the framework version: Then, run the ``composer update`` command. +.. note:: If you fix the version number like ``"codeigniter4/framework": "4.4.8"`` + in your **composer.json**, ``composer update`` command will not update the + framework. See `Writing Version Constraints`_ for how to specify the version. + Pros ---- From 999f7e42dfc23b5c0b3fc0a009bf890cd82521f8 Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 12 Apr 2024 15:29:43 +0900 Subject: [PATCH 5/6] docs: remove unneeded space --- user_guide_src/source/installation/installing_composer.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/user_guide_src/source/installation/installing_composer.rst b/user_guide_src/source/installation/installing_composer.rst index 557f81e8d5b8..e4811abd355f 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -89,7 +89,7 @@ the framework version: Then, run the ``composer update`` command. .. note:: If you fix the version number like ``"codeigniter4/framework": "4.4.8"`` - in your **composer.json**, ``composer update`` command will not update the + in your **composer.json**, ``composer update`` command will not update the framework. See `Writing Version Constraints`_ for how to specify the version. .. _Writing Version Constraints: https://getcomposer.org/doc/articles/versions.md#writing-version-constraints @@ -132,7 +132,7 @@ the framework version: Then, run the ``composer update`` command. .. note:: If you fix the version number like ``"codeigniter4/framework": "4.4.8"`` - in your **composer.json**, ``composer update`` command will not update the + in your **composer.json**, ``composer update`` command will not update the framework. See `Writing Version Constraints`_ for how to specify the version. Pros From 678bfd2072f17c09455e47fec7297ee03ab4a46a Mon Sep 17 00:00:00 2001 From: kenjis Date: Sat, 13 Apr 2024 06:48:37 +0900 Subject: [PATCH 6/6] docs: fix by proofreading Co-authored-by: Michal Sniatala --- .../source/installation/installing_composer.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/user_guide_src/source/installation/installing_composer.rst b/user_guide_src/source/installation/installing_composer.rst index e4811abd355f..3dd4c2a6a1b7 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -88,9 +88,9 @@ the framework version: Then, run the ``composer update`` command. -.. note:: If you fix the version number like ``"codeigniter4/framework": "4.4.8"`` +.. note:: When you use a fixed version number like ``"codeigniter4/framework": "4.4.8"`` in your **composer.json**, ``composer update`` command will not update the - framework. See `Writing Version Constraints`_ for how to specify the version. + framework to the latest version. See `Writing Version Constraints`_ for how to specify the version. .. _Writing Version Constraints: https://getcomposer.org/doc/articles/versions.md#writing-version-constraints @@ -131,9 +131,9 @@ the framework version: Then, run the ``composer update`` command. -.. note:: If you fix the version number like ``"codeigniter4/framework": "4.4.8"`` +.. note:: When you use a fixed version number like ``"codeigniter4/framework": "4.4.8"`` in your **composer.json**, ``composer update`` command will not update the - framework. See `Writing Version Constraints`_ for how to specify the version. + framework to the latest version. See `Writing Version Constraints`_ for how to specify the version. Pros ---- @@ -272,7 +272,7 @@ and check Breaking Changes and Enhancements. Upgrading to a Specified Version ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -For example, you may want to upgrade to v4.4.8 after v4.5.0 has been released. +For example, you may want to upgrade from v4.4.7 to v4.4.8 after v4.5.0 has been released. In that case, open **composer.json** in your project root folder, and specify the framework version: