Skip to content

Commit ee9d6ec

Browse files
authored
minor cleanup (#8169)
1 parent 57b923d commit ee9d6ec

5 files changed

Lines changed: 38 additions & 41 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ CakePHP Documentation
22
=====================
33

44
[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgreen.svg)](https://creativecommons.org/licenses/by-nc-sa/4.0/)
5-
[![Build Status](https://github.com/cakephp/docs/actions/workflows/ci.yml/badge.svg?branch=5.x)](https://github.com/cakephp/docs/actions/workflows/ci.yml)
5+
[![Build Status](https://github.com/cakephp/docs/actions/workflows/deploy_5.yml/badge.svg?branch=5.x)](https://github.com/cakephp/docs/actions/workflows/deploy_5.yml)
66

77
This is the official documentation for the CakePHP project. It is available
88
online at https://book.cakephp.org.

docs/en/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ If you want to configure a new project, you just need:
122122

123123
If you have an existing project:
124124

125-
``` text
125+
``` shell
126126
git clone <your-cakephp-repo>
127127
cd <your-cakephp-project>
128128
ddev config --project-type=cakephp --docroot=webroot

docs/en/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,8 +120,8 @@ we prepared with `set()`.
120120
Now that you are familiar with the different layers in CakePHP, lets review how
121121
a request cycle works in CakePHP:
122122

123-
<figure class="align-center">
124-
<img src="/typical-cake-request.png" alt="Flow diagram showing a typical CakePHP request" />
123+
<figure>
124+
<img src="/typical-cake-request.png" alt="Flow diagram showing a typical CakePHP request" style="margin: 0 auto" />
125125
</figure>
126126

127127
The typical CakePHP request cycle starts with a user requesting a page or

docs/en/intro/cakephp-folder-structure.md

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3,69 +3,68 @@
33
After you've downloaded the CakePHP application skeleton, there are a few top
44
level folders you should see:
55

6-
- The *bin* folder holds the Cake console executables.
6+
- `bin` holds the Cake console executables so you can execute e.g. `bin/cake bake all`.
77

8-
- The *config* folder holds the [Configuration](../development/configuration) files
9-
CakePHP uses. Database connection details, bootstrapping, core configuration files
8+
- `config` holds the [Configuration](../development/configuration) files.
9+
Database connection details, bootstrapping, core configuration files
1010
and more should be stored here.
1111

12-
- The *plugins* folder is where the [Plugins](../plugins) your application uses are stored.
12+
- `plugins` is where the [Plugins](../plugins) your application uses are stored.
1313

14-
- The *logs* folder normally contains your log files, depending on your log
15-
configuration.
14+
- `logs` contains your log files, can be adjusted via [Log Configuration](../core-libraries/logging.md#logging-configuration).
1615

17-
- The *src* folder will be where your application’s source files will be placed.
16+
- `src` will be where your application’s source files like Controllers, Models, Commands etc. will be placed.
1817

19-
- The *templates* folder has presentational files placed here:
18+
- `templates` has presentational files placed here:
2019
elements, error pages, layouts, and view template files.
2120

22-
- The *resources* folder has sub folder for various types of resource files.
23-
The *locales* sub folder stores language files for internationalization.
21+
- `resources` is primarily used for the `locales` sub folder storing language files for static internationalization.
2422

25-
- The *tests* folder will be where you put the test cases for your application.
23+
- `tests` will be where you put the test cases for your application.
2624

27-
- The *tmp* folder is where CakePHP stores temporary data. The actual data it
25+
- `tmp` is where CakePHP stores temporary data. The actual data it
2826
stores depends on how you have CakePHP configured, but this folder
2927
is usually used to store translation messages, model descriptions and sometimes
3028
session information.
3129

32-
- The *vendor* folder is where CakePHP and other application dependencies will
33-
be installed by [Composer](https://getcomposer.org). Editing these files is not
34-
advised, as Composer will overwrite your changes next time you update.
30+
- `vendor` is where CakePHP and other application dependencies will
31+
be installed by [Composer](https://getcomposer.org). **Editing these files is not
32+
advised, as Composer will overwrite your changes next time you update.**
3533

36-
- The *webroot* directory is the public document root of your application. It
34+
- `webroot` is the public document root of your application. It
3735
contains all the files you want to be publicly reachable.
3836

39-
Make sure that the *tmp* and *logs* folders exist and are writable,
40-
otherwise the performance of your application will be severely
41-
impacted. In debug mode, CakePHP will warn you, if these directories are not
42-
writable.
37+
Make sure that the `tmp` and `logs` folders exist and are writable,
38+
otherwise the performance of your application will be severely
39+
impacted. In debug mode, CakePHP will warn you, if these directories are not
40+
writable.
4341

4442
## The src Folder
4543

46-
CakePHP's *src* folder is where you will do most of your application
44+
CakePHP's `src` folder is where you will do most of your application
4745
development. Let's look a little closer at the folders inside
48-
*src*.
46+
`src`.
4947

50-
Command
48+
### Command
5149
Contains your application's console commands. See
5250
[Command Objects](../console-commands/commands) to learn more.
5351

54-
Console
52+
> [!NOTE]
53+
> The folder `Command` is not present by default.
54+
> It will be auto generated when you create your first command using bake.
55+
56+
### Console
5557
Contains the installation script executed by Composer.
5658

57-
Controller
59+
### Controller
5860
Contains your application's [Controllers](../controllers) and their components.
5961

60-
Middleware
62+
### Middleware
6163
Stores any [Middleware](../controllers/middleware) for your application.
6264

63-
Model
64-
Contains your application's tables, entities and behaviors.
65+
### Model
66+
Contains your application's [Tables](../orm/table-objects.md), [Entities](../orm/entities.md) and [Behaviors](../orm/behaviors.md).
6567

66-
View
67-
Presentational classes are placed here: views, cells, helpers.
68+
### View
69+
Presentational classes are placed here: [Views](../views.md), [Cells](../views/cells.md), [Helpers](../views/helpers.md).
6870

69-
> [!NOTE]
70-
> The folder `Command` is not present by default.
71-
> You can add it when you need it.

docs/en/intro/where-to-get-help.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,8 @@ framework. It's a straight forward code reference, so bring your propeller hat.
3838
## The Test Cases
3939

4040
If you ever feel the information provided in the API is not sufficient, check
41-
out the code of the test cases provided with CakePHP. They can serve as
42-
practical examples for function and data member usage for a class. :
43-
44-
tests/TestCase/
41+
out the code of the test cases provided with CakePHP in `tests/TestCase/`.
42+
They can serve as practical examples for function and data member usage for a class.
4543

4644
## Slack
4745

0 commit comments

Comments
 (0)