From 194174146c3a4ea69b069166a33ea975875d9bac Mon Sep 17 00:00:00 2001 From: kenjis Date: Sat, 3 Dec 2022 09:15:18 +0900 Subject: [PATCH 1/2] docs: add sections and TOC --- user_guide_src/source/intro/requirements.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/user_guide_src/source/intro/requirements.rst b/user_guide_src/source/intro/requirements.rst index 191e264733ec..b029fa74b488 100644 --- a/user_guide_src/source/intro/requirements.rst +++ b/user_guide_src/source/intro/requirements.rst @@ -2,12 +2,24 @@ Server Requirements ################### +.. contents:: + :local: + :depth: 2 + +*************************** +PHP and Required Extensions +*************************** + `PHP `_ version 7.4 or newer is required, with the following PHP extensions are enabled: - `intl `_ - `mbstring `_ - `json `_ +*********************** +Optional PHP Extensions +*********************** + The following PHP extensions should be enabled on your server: - `mysqlnd `_ (if you use MySQL) @@ -28,6 +40,12 @@ The following PHP extensions are required when you use PHPUnit: - `libxml `_ (if you use :doc:`TestResponse ` class) - `xdebug `_ (if you use ``CIUnitTestCase::assertHeaderEmitted()``) +.. _requirements-supported-databases: + +******************* +Supported Databases +******************* + A database is required for most web application programming. Currently supported databases are: From 728e86f7a665504aeeba98b845f7cfef18c747ed Mon Sep 17 00:00:00 2001 From: kenjis Date: Sat, 3 Dec 2022 09:16:14 +0900 Subject: [PATCH 2/2] docs: add or improve links --- user_guide_src/source/database/configuration.rst | 3 +++ user_guide_src/source/tutorial/news_section.rst | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/user_guide_src/source/database/configuration.rst b/user_guide_src/source/database/configuration.rst index 0e37f90073b3..762a81351658 100644 --- a/user_guide_src/source/database/configuration.rst +++ b/user_guide_src/source/database/configuration.rst @@ -6,6 +6,9 @@ Database Configuration :local: :depth: 2 +.. note:: + See :ref:`requirements-supported-databases` for currently supported database drivers. + *********** Config File *********** diff --git a/user_guide_src/source/tutorial/news_section.rst b/user_guide_src/source/tutorial/news_section.rst index fd555149573d..447887ea88db 100644 --- a/user_guide_src/source/tutorial/news_section.rst +++ b/user_guide_src/source/tutorial/news_section.rst @@ -14,7 +14,7 @@ Create a Database to Work with ****************************** The CodeIgniter installation assumes that you have set up an appropriate -database, as outlined in the :doc:`requirements `. +database, as outlined in the :ref:`requirements `. In this tutorial, we provide SQL code for a MySQL database, and we also assume that you have a suitable client for issuing database commands (mysql, MySQL Workbench, or phpMyAdmin). @@ -54,7 +54,7 @@ Connect to Your Database The local configuration file, ``.env``, that you created when you installed CodeIgniter, should have the database property settings uncommented and set appropriately for the database you want to use. Make sure you've configured -your database properly as described :doc:`here <../database/configuration>`:: +your database properly as described in :doc:`../database/configuration`:: database.default.hostname = localhost database.default.database = ci4tutorial