From ed4b80d20977890e55b6802a9f005e407bb0958e Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 1 Aug 2022 10:51:22 +0900 Subject: [PATCH 01/12] docs: fix description There are two techniques to describe. --- 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 5d550039b94e..1c9071df68c5 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -7,9 +7,9 @@ Composer Installation Composer can be used in several ways to install CodeIgniter4 on your system. -The first two techniques describe creating a skeleton project +The first technique describes creating a skeleton project using CodeIgniter4, that you would then use as the base for a new webapp. -The third technique described below lets you add CodeIgniter4 to an existing +The second technique described below lets you add CodeIgniter4 to an existing webapp, .. note:: If you are using a Git repository to store your code, or for From d9dfeb7875b013a66d12e2be26553967a2686ca5 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 1 Aug 2022 10:53:19 +0900 Subject: [PATCH 02/12] docs: fix section titles --- user_guide_src/source/installation/installing_composer.rst | 4 ++-- user_guide_src/source/installation/running.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/user_guide_src/source/installation/installing_composer.rst b/user_guide_src/source/installation/installing_composer.rst index 1c9071df68c5..9e08cc3cc697 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -27,8 +27,8 @@ the latest released version of the framework. This installation technique would suit a developer who wishes to start a new CodeIgniter4 based project. -Installation & Set Up ---------------------- +Installation +------------ In the folder above your project root:: diff --git a/user_guide_src/source/installation/running.rst b/user_guide_src/source/installation/running.rst index bb96d98f488d..373e529bd656 100644 --- a/user_guide_src/source/installation/running.rst +++ b/user_guide_src/source/installation/running.rst @@ -12,8 +12,8 @@ This section addresses how to use each technique, and explains some of the pros If you're new to CodeIgniter, please read the :doc:`Getting Started ` section of the User Guide to begin learning how to build dynamic PHP applications. Enjoy! -Initial Configuration & Set Up -============================== +Initial Configuration +===================== #. Open the **app/Config/App.php** file with a text editor and set your base URL. If you need more flexibility, the baseURL may From c746b49ce46b93f03d0374683706931fd7e4c7f2 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 1 Aug 2022 10:54:09 +0900 Subject: [PATCH 03/12] docs: fix title underlines --- .../source/installation/installing_manual.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/user_guide_src/source/installation/installing_manual.rst b/user_guide_src/source/installation/installing_manual.rst index f2ffac576dcf..8deb9b1055da 100644 --- a/user_guide_src/source/installation/installing_manual.rst +++ b/user_guide_src/source/installation/installing_manual.rst @@ -27,31 +27,31 @@ and extract it to become your project root. So if you install CodeIgniter under the folder that contains the special characters like ``(``, ``)``, etc., CodeIgniter won't work. Setting Up ----------- +===================== None .. _installing-manual-upgrading: 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. Pros ----- +==== Download and run Cons ----- +==== You are responsible for merge conflicts when updating Structure ---------- +========= Folders in your project after set up: app, public, system, writable From b8c3ff063fc09f663db4bb3a3ee0181429241ca4 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 1 Aug 2022 10:54:52 +0900 Subject: [PATCH 04/12] docs: add initial configuration It is required. --- .../source/installation/installing_composer.rst | 12 +++++++++++- .../source/installation/installing_manual.rst | 5 +++-- user_guide_src/source/installation/running.rst | 2 ++ 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/user_guide_src/source/installation/installing_composer.rst b/user_guide_src/source/installation/installing_composer.rst index 9e08cc3cc697..04184e62f497 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -52,7 +52,11 @@ A sample such installation command, using the default project-root "appstarter": > composer create-project codeigniter4/appstarter --no-dev -After installation you should follow the steps in the "Upgrading" section. +Initial Configuration +--------------------- + +After installation, a few initial configuration is required. +See :ref:`initial-configuration` for the detail. .. _app-starter-upgrading: @@ -148,6 +152,12 @@ 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** +Initial Configuration +--------------------- + +A few initial configuration is required. +See :ref:`initial-configuration` for the detail. + .. _adding-codeigniter4-upgrading: Upgrading diff --git a/user_guide_src/source/installation/installing_manual.rst b/user_guide_src/source/installation/installing_manual.rst index 8deb9b1055da..a8796f778736 100644 --- a/user_guide_src/source/installation/installing_manual.rst +++ b/user_guide_src/source/installation/installing_manual.rst @@ -26,10 +26,11 @@ and extract it to become your project root. The symbols that can be used are ``/``, ``_``, ``.``, ``:``, ``\`` and space. So if you install CodeIgniter under the folder that contains the special characters like ``(``, ``)``, etc., CodeIgniter won't work. -Setting Up +Initial Configuration ===================== -None +After installation, a few initial configuration is required. +See :ref:`initial-configuration` for the detail. .. _installing-manual-upgrading: diff --git a/user_guide_src/source/installation/running.rst b/user_guide_src/source/installation/running.rst index 373e529bd656..222e79870855 100644 --- a/user_guide_src/source/installation/running.rst +++ b/user_guide_src/source/installation/running.rst @@ -12,6 +12,8 @@ This section addresses how to use each technique, and explains some of the pros If you're new to CodeIgniter, please read the :doc:`Getting Started ` section of the User Guide to begin learning how to build dynamic PHP applications. Enjoy! +.. _initial-configuration: + Initial Configuration ===================== From 5417518c3f25cb654808b5ce8d25a42d98fe3428 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 1 Aug 2022 10:56:02 +0900 Subject: [PATCH 05/12] docs: add section title --- user_guide_src/source/installation/installing_composer.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/user_guide_src/source/installation/installing_composer.rst b/user_guide_src/source/installation/installing_composer.rst index 04184e62f497..18ec82c1407a 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -130,6 +130,9 @@ The same `CodeIgniter 4 framework `_ repository described in "Manual Installation" can also be added to an existing project using Composer. +Installation +------------ + Develop your app inside the ``app`` folder, and the ``public`` folder will be your document root. From 22a9ac7fbbb7346fdc524550516c39c62c17a75e Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 1 Aug 2022 10:56:23 +0900 Subject: [PATCH 06/12] docs: change section title --- 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 18ec82c1407a..b1aa485cb541 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -143,8 +143,8 @@ In your project root:: 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 ------- +Setting Up +---------- Copy the ``app``, ``public``, and ``writable`` folders from ``vendor/codeigniter4/framework`` to your project root From 0ef2bec2d8cd57a87280461243dd6ce6ef9f5ca1 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 1 Aug 2022 10:56:45 +0900 Subject: [PATCH 07/12] docs: change note position --- user_guide_src/source/installation/running.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/user_guide_src/source/installation/running.rst b/user_guide_src/source/installation/running.rst index 222e79870855..64ef5ec425b1 100644 --- a/user_guide_src/source/installation/running.rst +++ b/user_guide_src/source/installation/running.rst @@ -28,10 +28,10 @@ Initial Configuration in **.env** file to take advantage of the debugging tools provided. See :ref:`setting-development-mode` for the detail. -.. important:: In production environments, you should disable error display and - any other development-only functionality. In CodeIgniter, this can be done - by setting the environment to "production". By default, the application will - run using the "production" environment. See also :ref:`environment-constant`. + .. important:: In production environments, you should disable error display and + any other development-only functionality. In CodeIgniter, this can be done + by setting the environment to "production". By default, the application will + run using the "production" environment. See also :ref:`environment-constant`. .. note:: If you will be running your site using a web server (e.g., Apache or Nginx), you will need to modify the permissions for the ``writable`` folder inside From 71da80840408c05e259ec66b7d3160fac26e604f Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 1 Aug 2022 10:57:08 +0900 Subject: [PATCH 08/12] docs: add property name --- user_guide_src/source/installation/running.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user_guide_src/source/installation/running.rst b/user_guide_src/source/installation/running.rst index 64ef5ec425b1..ff7bf28abbe5 100644 --- a/user_guide_src/source/installation/running.rst +++ b/user_guide_src/source/installation/running.rst @@ -18,7 +18,7 @@ Initial Configuration ===================== #. Open the **app/Config/App.php** file with a text editor and - set your base URL. If you need more flexibility, the baseURL may + set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may be set within the **.env** file as ``app.baseURL = 'http://example.com/'``. (Always use a trailing slash on your base URL!) #. If you intend to use a database, open the From 1d641a5f73538c8bc2a1176119e7a48d4380fa24 Mon Sep 17 00:00:00 2001 From: kenjis Date: Mon, 1 Aug 2022 10:57:23 +0900 Subject: [PATCH 09/12] docs: add note about baseURL and debug toolbar --- user_guide_src/source/installation/running.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/user_guide_src/source/installation/running.rst b/user_guide_src/source/installation/running.rst index ff7bf28abbe5..4f24edd76950 100644 --- a/user_guide_src/source/installation/running.rst +++ b/user_guide_src/source/installation/running.rst @@ -21,6 +21,11 @@ Initial Configuration set your base URL to ``$baseURL``. If you need more flexibility, the baseURL may be set within the **.env** file as ``app.baseURL = 'http://example.com/'``. (Always use a trailing slash on your base URL!) + + .. note:: If you don't set the ``baseURL`` correctly, in development mode, + the debug toolbar may not load properly and web pages may take considerably + longer to display. + #. If you intend to use a database, open the **app/Config/Database.php** file with a text editor and set your database settings. Alternately, these could be set in your **.env** file. From 56b360aa05724dee0ecc450f1cdc3e9c2000366b Mon Sep 17 00:00:00 2001 From: kenjis Date: Tue, 2 Aug 2022 16:00:07 +0900 Subject: [PATCH 10/12] docs: fix by proofreading Co-authored-by: MGatner --- 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 b1aa485cb541..47b0ad7730f7 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -55,8 +55,8 @@ A sample such installation command, using the default project-root "appstarter": Initial Configuration --------------------- -After installation, a few initial configuration is required. -See :ref:`initial-configuration` for the detail. +After installation, a few initial configurations are required. +See :ref:`initial-configuration` for the details. .. _app-starter-upgrading: From b93cbed2a426bcee5694e81bfc1f2ea33dfc801c Mon Sep 17 00:00:00 2001 From: kenjis Date: Tue, 2 Aug 2022 16:00:18 +0900 Subject: [PATCH 11/12] docs: fix by proofreading Co-authored-by: MGatner --- 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 47b0ad7730f7..7b0b5d34b9f3 100644 --- a/user_guide_src/source/installation/installing_composer.rst +++ b/user_guide_src/source/installation/installing_composer.rst @@ -158,8 +158,8 @@ You will have to adjust the system path to refer to the vendor one, e.g., ``ROOT Initial Configuration --------------------- -A few initial configuration is required. -See :ref:`initial-configuration` for the detail. +A few initial configurations are required. +See :ref:`initial-configuration` for the details. .. _adding-codeigniter4-upgrading: From 9974df1ebdb05b523745b098a09e2d90b657d51e Mon Sep 17 00:00:00 2001 From: kenjis Date: Tue, 2 Aug 2022 16:00:32 +0900 Subject: [PATCH 12/12] docs: fix by proofreading Co-authored-by: MGatner --- user_guide_src/source/installation/installing_manual.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user_guide_src/source/installation/installing_manual.rst b/user_guide_src/source/installation/installing_manual.rst index a8796f778736..aa710dcdf257 100644 --- a/user_guide_src/source/installation/installing_manual.rst +++ b/user_guide_src/source/installation/installing_manual.rst @@ -29,7 +29,7 @@ and extract it to become your project root. Initial Configuration ===================== -After installation, a few initial configuration is required. +After installation, a few initial configurations are required. See :ref:`initial-configuration` for the detail. .. _installing-manual-upgrading: