From c28d551a5c345ef7b54dc7f5570927b6bd2a6e66 Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 16 Feb 2024 09:38:27 +0900 Subject: [PATCH 1/5] docs: replace link text `here` --- README.md | 2 +- admin/framework/README.md | 4 ++-- admin/starter/README.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e8a48b0e0205..fadb4c2e95fd 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ More information about the plans for version 4 can be found in [CodeIgniter 4](h The [User Guide](https://codeigniter4.github.io/userguide/) is the primary documentation for CodeIgniter 4. -The current **in-progress** User Guide can be found [here](https://codeigniter4.github.io/CodeIgniter4/). +You will also find the [current **in-progress** User Guide](https://codeigniter4.github.io/CodeIgniter4/). As with the rest of the framework, it is a work in progress, and will see changes over time to structure, explanations, etc. You might also be interested in the [API documentation](https://codeigniter4.github.io/api/) for the framework components. diff --git a/admin/framework/README.md b/admin/framework/README.md index 00cdf704c2f4..cc89820f0c2f 100644 --- a/admin/framework/README.md +++ b/admin/framework/README.md @@ -11,8 +11,8 @@ It has been built from the More information about the plans for version 4 can be found in [CodeIgniter 4](https://forum.codeigniter.com/forumdisplay.php?fid=28) on the forums. -The user guide corresponding to the latest version of the framework can be found -[here](https://codeigniter4.github.io/userguide/). +You can read the [user guide](https://codeigniter4.github.io/userguide/) +corresponding to the latest version of the framework. ## Important Change with index.php diff --git a/admin/starter/README.md b/admin/starter/README.md index 11d1cf13eec4..6b48a6eab7e8 100644 --- a/admin/starter/README.md +++ b/admin/starter/README.md @@ -11,8 +11,8 @@ It has been built from the More information about the plans for version 4 can be found in [CodeIgniter 4](https://forum.codeigniter.com/forumdisplay.php?fid=28) on the forums. -The user guide corresponding to the latest version of the framework can be found -[here](https://codeigniter4.github.io/userguide/). +You can read the [user guide](https://codeigniter4.github.io/userguide/) +corresponding to the latest version of the framework. ## Installation & updates From 358843d57d832934fb16c50c00d0b8df29789965 Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 16 Feb 2024 09:41:15 +0900 Subject: [PATCH 2/5] docs: use GitHub markdown note --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fadb4c2e95fd..67e22254a0d7 100644 --- a/README.md +++ b/README.md @@ -48,9 +48,10 @@ CodeIgniter is developed completely on a volunteer basis. As such, please give u for your issues to be reviewed. If you haven't heard from one of the team in that time period, feel free to leave a comment on the issue so that it gets brought back to our attention. -We use GitHub issues to track **BUGS** and to track approved **DEVELOPMENT** work packages. -We use our [forum](http://forum.codeigniter.com) to provide SUPPORT and to discuss -FEATURE REQUESTS. +> [!IMPORTANT] +> We use GitHub issues to track **BUGS** and to track approved **DEVELOPMENT** work packages. +> We use our [forum](http://forum.codeigniter.com) to provide SUPPORT and to discuss +> FEATURE REQUESTS. If you raise an issue here that pertains to support or a feature request, it will be closed! If you are not sure if you have found a bug, raise a thread on the forum first - From 85ae66c0486cf3e36ba028f3afa1ead69f0422f7 Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 16 Feb 2024 09:48:32 +0900 Subject: [PATCH 3/5] docs: update end of life dates for PHP --- README.md | 9 +++++---- admin/framework/README.md | 9 +++++---- admin/starter/README.md | 9 +++++---- 3 files changed, 15 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 67e22254a0d7..77a869530b3c 100644 --- a/README.md +++ b/README.md @@ -92,10 +92,11 @@ PHP version 7.4 or higher is required, with the following extensions installed: - [intl](http://php.net/manual/en/intl.requirements.php) - [mbstring](http://php.net/manual/en/mbstring.installation.php) -> **Warning** -> The end of life date for PHP 7.4 was November 28, 2022. If you are -> still using PHP 7.4, you should upgrade immediately. The end of life date -> for PHP 8.0 will be November 26, 2023. +> [!WARNING] +> The end of life date for PHP 7.4 was November 28, 2022. +> The end of life date for PHP 8.0 was November 26, 2023. +> If you are still using PHP 7.4 or 8.0, you should upgrade immediately. +> The end of life date for PHP 8.1 will be November 25, 2024. Additionally, make sure that the following extensions are enabled in your PHP: diff --git a/admin/framework/README.md b/admin/framework/README.md index cc89820f0c2f..bc8646fcac1e 100644 --- a/admin/framework/README.md +++ b/admin/framework/README.md @@ -47,10 +47,11 @@ PHP version 7.4 or higher is required, with the following extensions installed: - [intl](http://php.net/manual/en/intl.requirements.php) - [mbstring](http://php.net/manual/en/mbstring.installation.php) -> **Warning** -> The end of life date for PHP 7.4 was November 28, 2022. If you are -> still using PHP 7.4, you should upgrade immediately. The end of life date -> for PHP 8.0 will be November 26, 2023. +> [!WARNING] +> The end of life date for PHP 7.4 was November 28, 2022. +> The end of life date for PHP 8.0 was November 26, 2023. +> If you are still using PHP 7.4 or 8.0, you should upgrade immediately. +> The end of life date for PHP 8.1 will be November 25, 2024. Additionally, make sure that the following extensions are enabled in your PHP: diff --git a/admin/starter/README.md b/admin/starter/README.md index 6b48a6eab7e8..3fb517ced321 100644 --- a/admin/starter/README.md +++ b/admin/starter/README.md @@ -55,10 +55,11 @@ PHP version 7.4 or higher is required, with the following extensions installed: - [intl](http://php.net/manual/en/intl.requirements.php) - [mbstring](http://php.net/manual/en/mbstring.installation.php) -> **Warning** -> The end of life date for PHP 7.4 was November 28, 2022. If you are -> still using PHP 7.4, you should upgrade immediately. The end of life date -> for PHP 8.0 will be November 26, 2023. +> [!WARNING] +> The end of life date for PHP 7.4 was November 28, 2022. +> The end of life date for PHP 8.0 was November 26, 2023. +> If you are still using PHP 7.4 or 8.0, you should upgrade immediately. +> The end of life date for PHP 8.1 will be November 25, 2024. Additionally, make sure that the following extensions are enabled in your PHP: From 70d25a7891467987779877bd85a2c9bef651426b Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 16 Feb 2024 09:58:42 +0900 Subject: [PATCH 4/5] docs: decorate file name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 77a869530b3c..18c8d81c624b 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ You might also be interested in the [API documentation](https://codeigniter4.git ## Important Change with index.php -index.php is no longer in the root of the project! It has been moved inside the *public* folder, +`index.php` is no longer in the root of the project! It has been moved inside the *public* folder, for better security and separation of components. This means that you should configure your web server to "point" to your project's *public* folder, and From f1c6367706f80333d003d53be880f1967ebd49a1 Mon Sep 17 00:00:00 2001 From: kenjis Date: Fri, 16 Feb 2024 10:25:22 +0900 Subject: [PATCH 5/5] docs: use codeigniter.com URLs for user gude --- README.md | 2 +- admin/framework/README.md | 2 +- admin/starter/README.md | 2 +- admin/starter/tests/README.md | 6 +++--- tests/README.md | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 18c8d81c624b..1508d10b28a6 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ More information about the plans for version 4 can be found in [CodeIgniter 4](h ### Documentation -The [User Guide](https://codeigniter4.github.io/userguide/) is the primary documentation for CodeIgniter 4. +The [User Guide](https://codeigniter.com/user_guide/) is the primary documentation for CodeIgniter 4. You will also find the [current **in-progress** User Guide](https://codeigniter4.github.io/CodeIgniter4/). As with the rest of the framework, it is a work in progress, and will see changes over time to structure, explanations, etc. diff --git a/admin/framework/README.md b/admin/framework/README.md index bc8646fcac1e..30843d0d9716 100644 --- a/admin/framework/README.md +++ b/admin/framework/README.md @@ -11,7 +11,7 @@ It has been built from the More information about the plans for version 4 can be found in [CodeIgniter 4](https://forum.codeigniter.com/forumdisplay.php?fid=28) on the forums. -You can read the [user guide](https://codeigniter4.github.io/userguide/) +You can read the [user guide](https://codeigniter.com/user_guide/) corresponding to the latest version of the framework. ## Important Change with index.php diff --git a/admin/starter/README.md b/admin/starter/README.md index 3fb517ced321..976259fc14c1 100644 --- a/admin/starter/README.md +++ b/admin/starter/README.md @@ -11,7 +11,7 @@ It has been built from the More information about the plans for version 4 can be found in [CodeIgniter 4](https://forum.codeigniter.com/forumdisplay.php?fid=28) on the forums. -You can read the [user guide](https://codeigniter4.github.io/userguide/) +You can read the [user guide](https://codeigniter.com/user_guide/) corresponding to the latest version of the framework. ## Installation & updates diff --git a/admin/starter/tests/README.md b/admin/starter/tests/README.md index ad4c74d97a24..fc40e447301e 100644 --- a/admin/starter/tests/README.md +++ b/admin/starter/tests/README.md @@ -7,7 +7,7 @@ use to test your application. Those details can be found in the documentation. ## Resources -* [CodeIgniter 4 User Guide on Testing](https://codeigniter4.github.io/userguide/testing/index.html) +* [CodeIgniter 4 User Guide on Testing](https://codeigniter.com/user_guide/testing/index.html) * [PHPUnit docs](https://phpunit.de/documentation.html) * [Any tutorials on Unit testing in CI4?](https://forum.codeigniter.com/showthread.php?tid=81830) @@ -38,7 +38,7 @@ In order to set up the database edit the details for the `tests` group in **app/Config/Database.php** or **.env**. Make sure that you provide a database engine that is currently running on your machine. More details on a test database setup are in the -[Testing Your Database](https://codeigniter4.github.io/userguide/testing/database.html) section of the documentation. +[Testing Your Database](https://codeigniter.com/user_guide/testing/database.html) section of the documentation. ## Running the tests @@ -114,5 +114,5 @@ Review the links above and always pay attention to your code coverage. Tests can include migrating, seeding, and testing against a mock or live database. Be sure to modify the test case (or create your own) to point to your seed and migrations and include any additional steps to be run before tests in the `setUp()` method. -See [Testing Your Database](https://codeigniter4.github.io/userguide/testing/database.html) +See [Testing Your Database](https://codeigniter.com/user_guide/testing/database.html) for details. diff --git a/tests/README.md b/tests/README.md index 52ddc1e6711f..0e5dbbe3312a 100644 --- a/tests/README.md +++ b/tests/README.md @@ -7,7 +7,7 @@ use to test your application. Those details can be found in the documentation. ## Resources -* [CodeIgniter 4 User Guide on Testing](https://codeigniter4.github.io/userguide/testing/index.html) +* [CodeIgniter 4 User Guide on Testing](https://codeigniter.com/user_guide/testing/index.html) * [PHPUnit docs](https://phpunit.de/documentation.html) * [Any tutorials on Unit testing in CI4?](https://forum.codeigniter.com/showthread.php?tid=81830)