Merge pull request #7020 from kenjis/fix-docs-upgrade

docs: improve past upgrade

Author: kenjis

user_guide_src/source/installation/upgrade_404.rst

@@ -15,7 +15,11 @@ Please refer to the upgrade instructions corresponding to your installation meth
 CodeIgniter 4.0.4 fixes a bug in the implementation of :doc:`Controller Filters </incoming/filters>`, breaking
 code implementing the ``FilterInterface``.
 
-**Update FilterInterface declarations**
+Breaking Changes
+****************
+
+Update FilterInterface Declarations
+===================================
 
 The method signatures for ``after()`` and ``before()`` must be updated to include ``$arguments``. The function
 definitions should be changed from::

user_guide_src/source/installation/upgrade_405.rst

@@ -12,7 +12,11 @@ Please refer to the upgrade instructions corresponding to your installation meth
     :local:
     :depth: 2
 
-**Cookie SameSite support**
+Breaking Enhancements
+*********************
+
+Cookie SameSite Support
+=======================
 
 CodeIgniter 4.0.5 introduces a setting for the cookie SameSite attribute. Prior versions did not set this
 attribute at all. The default setting for cookies is now `Lax`. This will affect how cookies are handled in
@@ -23,7 +27,8 @@ For additional information, see `MDN Web Docs <https://developer.mozilla.org/pl/
 The SameSite specifications are described in `RFC 6265 <https://tools.ietf.org/html/rfc6265>`_
 and the `RFC 6265bis revision <https://datatracker.ietf.org/doc/draft-ietf-httpbis-rfc6265bis/?include_text=1>`_.
 
-**Message::getHeader(s)**
+Message::getHeader(s)
+=====================
 
 The HTTP layer is moving towards `PSR-7 compliance <https://www.php-fig.org/psr/psr-7/>`_. Towards this end
 ``Message::getHeader()`` and ``Message::getHeaders()`` are deprecated and should be replaced
@@ -41,7 +46,8 @@ Additional related deprecations from the HTTP layer:
 * ``Response[Interface]::getReason()``: Use ``getReasonPhrase()`` instead
 * ``Response[Interface]::getStatusCode()``: The explicit ``int`` return type will be removed (no action required)
 
-**ResponseInterface**
+ResponseInterface
+=================
 
 This interface intends to include the necessary methods for any framework-compatible response class.
 A number of methods expected by the framework were missing and have now been added. If you use any
@@ -68,13 +74,14 @@ updated requirements. These methods are as follows:
 To facilitate use of this interface these methods have been moved from the framework's ``Response`` into a ``ResponseTrait``
 which you may use, and ``DownloadResponse`` now extends ``Response`` directly to ensure maximum compatibility.
 
-**Config\Services**
+Config\\Services
+================
 
 Service discovery has been updated to allow third-party services (when enabled via Modules) to take precedence over core services. Update
 **app/Config/Services.php** so the class extends ``CodeIgniter\Config\BaseService`` to allow proper discovery of third-party services.
 
 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.
@@ -86,7 +93,7 @@ the project space: `Explore on Packagist <https://packagist.org/explore/?query=c
     and any mandatory changes will be covered in the sections above.
 
 Content Changes
----------------
+===============
 
 The following files received significant changes (including deprecations or visual adjustments)
 and it is recommended that you merge the updated versions with your application:
@@ -99,7 +106,7 @@ and it is recommended that you merge the updated versions with your application:
 * ``composer.json``
 
 All 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:

user_guide_src/source/installation/upgrade_410.rst

@@ -15,7 +15,8 @@ Please refer to the upgrade instructions corresponding to your installation meth
 Breaking Changes
 ****************
 
-**Legacy Autoloading**
+Legacy Autoloading
+==================
 
 ``Autoloader::loadLegacy()`` method was originally for transition to CodeIgniter v4. Since v4.1.0,
 this support was removed. All classes must be namespaced.

user_guide_src/source/installation/upgrade_412.rst

@@ -12,15 +12,20 @@ Please refer to the upgrade instructions corresponding to your installation meth
     :local:
     :depth: 2
 
-**current_url() and indexPage**
+Breaking Changes
+****************
+
+current_url() and indexPage
+===========================
 
 Due to `a bug <https://github.com/codeigniter4/CodeIgniter4/issues/4116>`_ in ``current_url()``,
 the resulting URIs could be incorrect for a project's configuration, most importantly: ``indexPage``
 would *not* be included. Projects using ``App::$indexPage`` should expect altered values from
 ``current_url()`` and all its dependencies (including Response Testing, Pager, Form Helper, Pager,
 and View Parser). Update your projects accordingly.
 
-**Cache Keys**
+Cache Keys
+==========
 
 Cache handlers had wildly different compatibility for keys. The updated cache drivers now pass
 all keys through validation, roughly matching PSR-6's recommendations:
@@ -35,22 +40,28 @@ all keys through validation, roughly matching PSR-6's recommendations:
 
 Update your projects to remove any invalid cache keys.
 
-**BaseConnection::query() return values**
+BaseConnection::query() Return Values
+=====================================
 
 ``BaseConnection::query()`` method in prior versions was incorrectly returning BaseResult objects
 even if the query failed. This method will now return ``false`` for failed queries (or throw an
-Exception if ``DBDebug==true``) and will return booleans for write-type queries. Review any use
+Exception if ``DBDebug`` is ``true``) and will return booleans for write-type queries. Review any use
 of ``query()`` method and be assess whether the value might be boolean instead of Result object.
 For a better idea of what queries are write-type queries, check ``BaseConnection::isWriteType()``
 and any DBMS-specific override ``isWriteType()`` in the relevant Connection class.
 
-**ConnectionInterface::isWriteType() declaration added**
+Breaking Enhancements
+*********************
+
+ConnectionInterface::isWriteType() Declaration Added
+====================================================
 
 If you have written any classes that implement ConnectionInterface, these must now implement the
 ``isWriteType()`` method, declared as ``public function isWriteType($sql): bool``. If your class extends BaseConnection, then that class will provide a basic ``isWriteType()``
 method which you might want to override.
 
-**Test Traits**
+Test Traits
+===========
 
 The ``CodeIgniter\Test`` namespace has had significant improvements to help developers with their
 own test cases. Most notably test extensions have moved to Traits to make them easier to
@@ -68,7 +79,8 @@ and use any traits you need. For example:
 Finally, ``ControllerTester`` has been superseded by ``ControllerTestTrait`` to standardize
 approach and take advantage of the updated response testing (below).
 
-**Test Responses**
+Test Responses
+==============
 
 The tools for testing responses have been consolidated and improved. A new
 ``TestResponse`` replaces ``ControllerResponse`` and ``FeatureResponse`` with a complete
@@ -80,7 +92,7 @@ changes to be aware of:
 * ``TestResponse`` does not have ``getBody()`` and ``setBody()`` methods, but rather uses the Response methods directly, e.g.: ``$body = $result->response()->getBody();``
 
 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.
@@ -92,7 +104,7 @@ the project space: `Explore on Packagist <https://packagist.org/explore/?query=c
     and any mandatory changes will be covered in the sections above.
 
 Content Changes
----------------
+===============
 
 The following files received significant changes (including deprecations or visual adjustments)
 and it is recommended that you merge the updated versions with your application:
@@ -108,7 +120,7 @@ and it is recommended that you merge the updated versions with your application:
 * ``spark``
 
 All 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:

user_guide_src/source/installation/upgrade_413.rst

@@ -12,15 +12,19 @@ Please refer to the upgrade instructions corresponding to your installation meth
     :local:
     :depth: 2
 
-**Cache TTL**
+Breaking Enhancements
+*********************
+
+Cache TTL
+=========
 
 There is a new value in **app/Config/Cache.php**: ``$ttl``. This is not used by framework
 handlers where 60 seconds is hard-coded, but may be useful to projects and modules.
 In a future release this value will replace the hard-coded version, so either leave this as
 ``60`` or stop relying on the hard-coded version.
 
 Project Files
-=============
+*************
 
 Only a few 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.

user_guide_src/source/installation/upgrade_414.rst

@@ -15,9 +15,13 @@ Please refer to the upgrade instructions corresponding to your installation meth
 This release focuses on code style. All changes (except those noted below) are cosmetic to bring the code in line with the new
 `CodeIgniter Coding Standard <https://github.com/CodeIgniter/coding-standard>`_ (based on PSR-12).
 
-**Method Scope**
+Breaking Changes
+****************
 
-The following methods were changed from "public" to "protected" to match their parent class methods and better align with their uses.
+Method Scope
+============
+
+The following methods were changed from ``public`` to ``protected`` to match their parent class methods and better align with their uses.
 If you relied on any of these methods being public (highly unlikely) adjust your code accordingly:
 
 * ``CodeIgniter\Database\MySQLi\Connection::execute()``
@@ -45,7 +49,7 @@ If you relied on any of these methods being public (highly unlikely) adjust your
 * ``CodeIgniter\Test\Mock\MockSecurity.php::sendCookie()``
 
 Project Files
-=============
+*************
 
 All files in the project space were reformatted with the new coding style. This will not affect
 existing code but you may want to apply the updated coding style to your own projects to keep

user_guide_src/source/installation/upgrade_415.rst

@@ -24,7 +24,7 @@ and modified the ``set()`` method, then you need to change its definition from
 ``public function set($key, ?string $value = '', ?bool $escape = null)`` to
 ``public function set($key, $value = '', ?bool $escape = null)``.
 
-Session DatabaseHandler's database table change
+Session DatabaseHandler's Database Table Change
 -----------------------------------------------
 
 The types of the following columns in the session table have been changed for optimization.
@@ -60,15 +60,15 @@ Protecting **GET** method needs only when you use ``form_open()`` auto-generatio
     because :ref:`auto-routing-legacy` permits any HTTP method to access a controller.
     Accessing the controller with a method you don't expect could bypass the filter.
 
-CURLRequest header change
+CURLRequest Header Change
 -------------------------
 
 In the previous version, if you didn't provide your own headers, ``CURLRequest`` would send the request-headers from the browser.
 The bug was fixed. If your requests depend on the headers, your requests might fail after upgrading.
 In this case, add the necessary headers manually.
 See :ref:`CURLRequest Class <curlrequest-request-options-headers>` for how to add.
 
-Query Builder changes
+Query Builder Changes
 ---------------------
 
 For optimization and a bug fix, the following behaviors, mostly used in testing, have been changed.
@@ -81,7 +81,7 @@ Breaking Enhancements
 
 .. _upgrade-415-multiple-filters-for-a-route:
 
-Multiple filters for a route
+Multiple Filters for a Route
 ----------------------------
 
 A new feature to set multiple filters for a route.

user_guide_src/source/installation/upgrade_416.rst

@@ -15,7 +15,7 @@ Please refer to the upgrade instructions corresponding to your installation meth
 Breaking Changes
 ****************
 
-Validation result changes
+Validation Result Changes
 =========================
 
 Due to a bug fix, the Validation now might change the validation results when you validate an array item (see :ref:`Changelog <changelog-v416-validation-changes>`). So check the validation results for all the code that validates the array. Validating multiple fields like ``contacts.*.name`` is not affected.

user_guide_src/source/installation/upgrade_418.rst

@@ -15,4 +15,4 @@ Please refer to the upgrade instructions corresponding to your installation meth
 Breaking Changes
 ****************
 
--  Due to a security issue in the ``API\ResponseTrait`` all trait methods are now scoped to ``protected``. See the `Security advisory` <https://github.com/codeigniter4/CodeIgniter4/security/advisories/GHSA-7528-7jg5-6g62>` for more information.
+-  Due to a security issue in the ``API\ResponseTrait`` all trait methods are now scoped to ``protected``. See the `Security advisory GHSA-7528-7jg5-6g62 <https://github.com/codeigniter4/CodeIgniter4/security/advisories/GHSA-7528-7jg5-6g62>`_ for more information.