Merge pull request #4585 from totoprayogo1916/update-docs1

user_guide update: remove whitespaces, convert tabs to spaces & adjust the over-extended lines
codeigniter4 · Apr 19, 2021 · 5e7d105 · 5e7d105
2 parents 643eeb7 + 6a1a59f
commit 5e7d105
Show file tree

Hide file tree

Showing 33 changed files with 153 additions and 131 deletions.
diff --git a/user_guide_src/source/changelogs/index.rst b/user_guide_src/source/changelogs/index.rst
@@ -3,32 +3,32 @@ Change Logs
 ###########
 
 Version |version|
-====================================================
+=================
 
 **List of all CodeIgniter4 releases**
 
 See all the changes.
 
 .. toctree::
-        :titlesonly:
+    :titlesonly:
 
-        v4.1.2
-        v4.1.1
-        v4.1.0
-        v4.0.5
-        v4.0.4
-        v4.0.3
-        v4.0.0
-        v4.0.0-rc.4
-        v4.0.0-rc.3
-        v4.0.0-rc.2
-        v4.0.0-rc.1
-        v4.0.0-beta.4
-        v4.0.0-beta.3
-        v4.0.0-beta.2
-        v4.0.0-beta.1
-        v4.0.0-alpha.5
-        v4.0.0-alpha.4
-        v4.0.0-alpha.3
-        v4.0.0-alpha.2
-        v4.0.0-alpha.1
+    v4.1.2
+    v4.1.1
+    v4.1.0
+    v4.0.5
+    v4.0.4
+    v4.0.3
+    v4.0.0
+    v4.0.0-rc.4
+    v4.0.0-rc.3
+    v4.0.0-rc.2
+    v4.0.0-rc.1
+    v4.0.0-beta.4
+    v4.0.0-beta.3
+    v4.0.0-beta.2
+    v4.0.0-beta.1
+    v4.0.0-alpha.5
+    v4.0.0-alpha.4
+    v4.0.0-alpha.3
+    v4.0.0-alpha.2
+    v4.0.0-alpha.1
diff --git a/user_guide_src/source/changelogs/v4.0.0-alpha.1.rst b/user_guide_src/source/changelogs/v4.0.0-alpha.1.rst
@@ -1,5 +1,5 @@
 Version 4.0.0-alpha.1
-=================================
+=====================
 
 Release Date: September 28, 2018
 
@@ -63,17 +63,17 @@ New packages list:
     - Language
         - \\ Language
     - Log
-        -   Logger, LoggerAwareTrait
-        -   \\ Handlers ...  Base, ChromeLogger, File, HandlerInterface
+        - Logger, LoggerAwareTrait
+        - \\ Handlers ...  Base, ChromeLogger, File, HandlerInterface
     - Pager
         - \\ Pager, PagerInterface, PagerRenderer
     - Router 
         - \\ RouteCollection, RouteCollectionInterface, Router, RouterInterface
     - Security 
         - \\ Security
     - Session
-        -   \\ Session, SessionInterface
-        -   \\ Handlers ... Base, File, Memcached, Redis
+        - \\ Session, SessionInterface
+        - \\ Handlers ... Base, File, Memcached, Redis
     - Test 
         - \\ CIDatabaseTestCase, CIUnitTestCase, FeatureResponse, FeatureTestCase, ReflectionHelper
         - \\ Filters \\ CITestStreamFilter
@@ -88,4 +88,4 @@ New packages list:
     - Validation
         - \\ CreditCardRules, FileRules, FormatRules, Rules, Validation, ValidationInterface
     - View
-        -   \\ Cell, Filters, Parser, Plugins, RendererInterface, View
+        - \\ Cell, Filters, Parser, Plugins, RendererInterface, View
diff --git a/user_guide_src/source/changelogs/v4.0.0-alpha.2.rst b/user_guide_src/source/changelogs/v4.0.0-alpha.2.rst
@@ -1,5 +1,5 @@
 Version 4.0.0-alpha.2
-=================================
+=====================
 
 Release Date: Oct 26, 2018
 
@@ -24,7 +24,7 @@ system /
     - CLI/
         - CommandRunner #1350, #1356
     - Commands/
-        - Server/Serve #1313 
+        - Server/Serve #1313
     - Config/
         - AutoloadConfig #1271
         - Services #1341

diff --git a/user_guide_src/source/changelogs/v4.0.0-alpha.3.rst b/user_guide_src/source/changelogs/v4.0.0-alpha.3.rst
@@ -1,5 +1,5 @@
 Version 4.0.0-alpha.3
-====================================================
+=====================
 
 Release Date: November 30, 2018
 

diff --git a/user_guide_src/source/changelogs/v4.0.0-alpha.4.rst b/user_guide_src/source/changelogs/v4.0.0-alpha.4.rst
@@ -1,5 +1,5 @@
 Version 4.0.0-alpha.4
-====================================================
+=====================
 
 Release Date: Dec 15, 2018
 

diff --git a/user_guide_src/source/changelogs/v4.0.0-alpha.5.rst b/user_guide_src/source/changelogs/v4.0.0-alpha.5.rst
@@ -1,5 +1,5 @@
 Version 4.0.0-alpha.5
-====================================================
+=====================
 
 Release Date: Jan 30, 2019
 

diff --git a/user_guide_src/source/changelogs/v4.0.0-beta.1.rst b/user_guide_src/source/changelogs/v4.0.0-beta.1.rst
@@ -1,7 +1,7 @@
 Version 4.0.0-beta.1
-====================================================
+====================
 
-Release Date: Not released
+Release Date: Mar 1, 2019
 
 Highlights:
 

diff --git a/user_guide_src/source/changelogs/v4.0.0-beta.2.rst b/user_guide_src/source/changelogs/v4.0.0-beta.2.rst
@@ -1,5 +1,5 @@
 Version 4.0.0-beta.2
-====================================================
+====================
 
 Release Date: April 4, 2019
 

diff --git a/user_guide_src/source/changelogs/v4.0.0-beta.3.rst b/user_guide_src/source/changelogs/v4.0.0-beta.3.rst
@@ -1,7 +1,7 @@
 Version 4.0.0-beta.3
-====================================================
+====================
 
-Release Date: Not released
+Release Date: May 7, 2019
 
 Highlights:
 

diff --git a/user_guide_src/source/changelogs/v4.0.0-beta.4.rst b/user_guide_src/source/changelogs/v4.0.0-beta.4.rst
@@ -1,7 +1,7 @@
 Version 4.0.0-beta.4
-====================================================
+====================
 
-Release Date: Not released
+Release Date: Jul 25, 2019
 
 Highlights:
 

diff --git a/user_guide_src/source/changelogs/v4.0.0-rc.1.rst b/user_guide_src/source/changelogs/v4.0.0-rc.1.rst
@@ -1,7 +1,7 @@
 Version 4.0.0-rc.1
-====================================================
+==================
 
-Release Date: Not released
+Release Date: Sep 3, 2019
 
 **RC.1 release of CodeIgniter4**
 

diff --git a/user_guide_src/source/changelogs/v4.0.0-rc.2.rst b/user_guide_src/source/changelogs/v4.0.0-rc.2.rst
@@ -1,5 +1,5 @@
 Version 4.0.0-rc.2
-====================================================
+==================
 
 Release Date: Sept 27, 2019
 

diff --git a/user_guide_src/source/changelogs/v4.0.0-rc.3.rst b/user_guide_src/source/changelogs/v4.0.0-rc.3.rst
@@ -1,5 +1,5 @@
 Version 4.0.0-rc.3
-====================================================
+==================
 
 Release Date: Oct 19, 2019
 

diff --git a/user_guide_src/source/changelogs/v4.0.0-rc.4.rst b/user_guide_src/source/changelogs/v4.0.0-rc.4.rst
@@ -1,5 +1,5 @@
 Version 4.0.0-rc.4
-====================================================
+==================
 
 Release Date: February 6, 2020
 

diff --git a/user_guide_src/source/changelogs/v4.0.0.rst b/user_guide_src/source/changelogs/v4.0.0.rst
@@ -1,5 +1,5 @@
 Version 4.0.0
-====================================================
+=============
 
 Release Date: February 24, 2020
 

diff --git a/user_guide_src/source/changelogs/v4.0.3.rst b/user_guide_src/source/changelogs/v4.0.3.rst
@@ -1,5 +1,5 @@
 Version 4.0.3
-====================================================
+=============
 
 Release Date: May 1, 2020
 

diff --git a/user_guide_src/source/changelogs/v4.0.4.rst b/user_guide_src/source/changelogs/v4.0.4.rst
@@ -1,5 +1,5 @@
 Version 4.0.4
-====================================================
+=============
 
 Release Date: July 15, 2020
 

diff --git a/user_guide_src/source/changelogs/v4.0.5.rst b/user_guide_src/source/changelogs/v4.0.5.rst
@@ -1,5 +1,5 @@
 Version 4.0.5
-====================================================
+=============
 
 Release Date: January 31, 2021
 

diff --git a/user_guide_src/source/changelogs/v4.1.0.rst b/user_guide_src/source/changelogs/v4.1.0.rst
@@ -1,5 +1,5 @@
 Version 4.1.0
-====================================================
+=============
 
 Release Date: January 31, 2021
 
@@ -11,10 +11,10 @@ Changes:
 
 Removed:
 
-- `Autoloader::loadLegacy()` method was previously used for migration of non-namespaced classes in transition to CodeIgniter v4. Since `4.1.0`, this support was removed.
+- ``Autoloader::loadLegacy()`` method was previously used for migration of non-namespaced classes in transition to CodeIgniter v4. Since ``4.1.0``, this support was removed.
 
 Bugs Fixed:
 
 Deprecations:
 
-- Deprecated `Model::fillPlaceholders(array $rules, array $data)` method, use `fillPlaceholders(array $rules, array $data)` from Validation instead.
+- Deprecated ``Model::fillPlaceholders(array $rules, array $data)`` method, use ``fillPlaceholders(array $rules, array $data)`` from Validation instead.
diff --git a/user_guide_src/source/changelogs/v4.1.1.rst b/user_guide_src/source/changelogs/v4.1.1.rst
@@ -1,12 +1,12 @@
 Version 4.1.1
-====================================================
+=============
 
 Release Date: February 1, 2021
 
 **4.1.1 release of CodeIgniter4**
 
 Bugs Fixed:
 
-- Fixed an issue where **.gitattributes** was preventing framework downloads.
+- Fixed an issue where ``.gitattributes`` was preventing framework downloads.
 
 Note that this fix was also applied retroactively to ``4.0.5`` on the **framework** repo.
diff --git a/user_guide_src/source/changelogs/v4.1.2.rst b/user_guide_src/source/changelogs/v4.1.2.rst
@@ -1,5 +1,5 @@
 Version 4.1.2
-====================================================
+=============
 
 Release Date: Not released
 

diff --git a/user_guide_src/source/installation/index.rst b/user_guide_src/source/installation/index.rst
@@ -26,7 +26,7 @@ However you choose to install and run CodeIgniter4, the
 `user guide <https://codeigniter4.github.io/userguide/>`_ is accessible online.
 
 .. note:: Before using CodeIgniter 4, make sure that your server meets the
-          :doc:`requirements </intro/requirements>`, in particular the PHP
-          version and the PHP extensions that are needed.
-          You may find that you have to uncomment the ``php.ini`` "extension"
-          lines to enable "curl" and "intl", for instance.
+    :doc:`requirements </intro/requirements>`, in particular the PHP
+    version and the PHP extensions that are needed.
+    You may find that you have to uncomment the ``php.ini`` "extension"
+    lines to enable "curl" and "intl", for instance.
diff --git a/user_guide_src/source/installation/installing_composer.rst b/user_guide_src/source/installation/installing_composer.rst
@@ -1,5 +1,5 @@
 Composer Installation
-###############################################################################
+#####################
 
 .. contents::
     :local:
@@ -18,7 +18,7 @@ webapp,
    when you clone the repository to a new system.
 
 App Starter
-============================================================
+===========
 
 The `CodeIgniter 4 app starter <https://github.com/codeigniter4/appstarter>`_
 repository holds a skeleton application, with a composer dependency on
@@ -28,7 +28,7 @@ This installation technique would suit a developer who wishes to start
 a new CodeIgniter4 based project.
 
 Installation & Set Up
--------------------------------------------------------
+---------------------
 
 In the folder above your project root::
 
@@ -51,7 +51,7 @@ A sample such installation command, using the default project-root "appstarter":
 After installation you should follow the steps in the "Upgrading" section.
 
 Upgrading
--------------------------------------------------------
+---------
 
 Whenever there is a new release, then from the command line in your project root::
 
@@ -71,17 +71,17 @@ 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.
 
 Pros
--------------------------------------------------------
+----
 
 Simple installation; easy to update
 
 Cons
--------------------------------------------------------
+----
 
 You still need to check for ``app/Config`` changes after updating
 
 Structure
--------------------------------------------------------
+---------
 
 Folders in your project after set up:
 
@@ -90,7 +90,7 @@ Folders in your project after set up:
 - vendor/codeigniter4/framework/app & public (compare with yours after updating when using ``--prefer-source``)
 
 Latest Dev
--------------------------------------------------------
+----------
 
 The App Starter repo comes with a ``builds`` scripts to switch Composer sources between the
 current stable release and the latest development branch of the framework. Use this script
@@ -114,7 +114,7 @@ After using the ``builds`` command be sure to run ``composer update`` to sync yo
 folder with the latest target build.
 
 Adding CodeIgniter4 to an Existing Project
-============================================================
+==========================================
 
 The same `CodeIgniter 4 framework <https://github.com/codeigniter4/framework>`_
 repository described in "Manual Installation" can also be added to an
@@ -131,7 +131,7 @@ As with the earlier two composer install methods, you can omit installing
 phpunit and its dependencies by adding the ``--no-dev`` argument to the ``composer require`` command.
 
 Set Up
--------------------------------------------------------
+------
 
 Copy the ``app``, ``public``, and ``writable`` folders from ``vendor/codeigniter4/framework``
 to your project root
@@ -143,7 +143,7 @@ You will have to adjust the system path to refer to the vendor one, e.g., ``ROOT
 - the ``$systemDirectory`` variable in ``app/Config/Paths.php``
 
 Upgrading
--------------------------------------------------------
+---------
 
 Whenever there is a new release, then from the command line in your project root::
 
@@ -153,17 +153,17 @@ Read the upgrade instructions, and check designated
 ``app/Config`` folders for affected changes.
 
 Pros
--------------------------------------------------------
+----
 
 Relatively simple installation; easy to update
 
 Cons
--------------------------------------------------------
+----
 
 You still need to check for ``app/Config`` changes after updating
 
 Structure
--------------------------------------------------------
+---------
 
 Folders in your project after set up:
 
@@ -172,7 +172,7 @@ Folders in your project after set up:
 
 
 Translations Installation
-============================================================
+=========================
 
 If you want to take advantage of the system message translations,
 they can be added to your project in a similar fashion.