Skip to content

Commit 46a5d1e

Browse files
authored
Merge pull request #7167 from kenjis/fix-docs-installing
docs: improve installation
2 parents 0eb0fca + 59261c3 commit 46a5d1e

2 files changed

Lines changed: 18 additions & 9 deletions

File tree

user_guide_src/source/installation/installing_composer.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ If you omit the "project-root" argument, the command will create an
5353

5454
> composer install --no-dev
5555

56-
The above command will removes the Composer packages only for development
56+
The above command will remove the Composer packages only for development
5757
that are not needed in the production environment. This will greatly reduce
5858
the vendor folder size.
5959

@@ -83,7 +83,11 @@ Cons
8383
----
8484

8585
You still need to check for file changes in the **project space**
86-
(root, app, public, writable) after updating.
86+
(root, app, public, writable) and merge them after updating.
87+
88+
.. note:: There are some third-party CodeIgniter modules available to assist
89+
with merging changes to the project space:
90+
`Explore on Packagist <https://packagist.org/explore/?query=codeigniter4%20updates>`_.
8791

8892
Structure
8993
---------
@@ -139,7 +143,7 @@ In your project root::
139143

140144
> composer install --no-dev
141145

142-
The above command will removes the Composer packages only for development
146+
The above command will remove the Composer packages only for development
143147
that are not needed in the production environment. This will greatly reduce
144148
the vendor folder size.
145149

@@ -178,6 +182,10 @@ Cons
178182
You still need to check for file changes in the **project space**
179183
(root, app, public, writable) after updating.
180184

185+
.. note:: There are some third-party CodeIgniter modules available to assist
186+
with merging changes to the project space:
187+
`Explore on Packagist <https://packagist.org/explore/?query=codeigniter4%20updates>`_.
188+
181189
Structure
182190
---------
183191

user_guide_src/source/installation/installing_manual.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ The `CodeIgniter 4 framework <https://github.com/codeigniter4/framework>`_
99
repository holds the released versions of the framework.
1010
It is intended for developers who do not wish to use Composer.
1111

12-
Develop your app inside the ``app`` folder, and the ``public`` folder
13-
will be your public-facing document root. Do not change anything inside the ``system``
12+
Develop your app inside the **app** folder, and the **public** folder
13+
will be your public-facing document root. Do not change anything inside the **system**
1414
folder!
1515

1616
.. note:: This is the installation technique closest to that described
@@ -37,7 +37,7 @@ See :ref:`initial-configuration` for the detail.
3737
Upgrading
3838
=========
3939

40-
Download a new copy of the framework, and then replace the ``system`` folder.
40+
Download a new copy of the framework, and then replace the **system** folder.
4141

4242
Read the :doc:`upgrade instructions <upgrading>`, and check Breaking Changes and Enhancements.
4343

@@ -49,7 +49,8 @@ Download and run.
4949
Cons
5050
====
5151

52-
You are responsible for merge conflicts when updating.
52+
You need to check for file changes in the **project space**
53+
(root, app, public, tests, writable) and merge them by yourself.
5354

5455
Structure
5556
=========
@@ -65,8 +66,8 @@ If you want to take advantage of the system message translations,
6566
they can be added to your project in a similar fashion.
6667

6768
Download the `latest version of them <https://github.com/codeigniter4/translations/releases/latest>`_.
68-
Extract the downloaded zip, and copy the ``Language`` folder contents in it
69-
to your ``PROJECT_ROOT/app/Languages`` folder.
69+
Extract the downloaded zip, and copy the **Language** folder contents in it
70+
to your **app/Languages** folder.
7071

7172
This would need to be repeated to incorporate any updates
7273
to the translations.

0 commit comments

Comments
 (0)