Skip to content

Commit 7bd5971

Browse files
LordSimaljosbeir
andauthored
improve SEO (#8220)
* improve SEO * update to use summarized descriptions --------- Co-authored-by: Jasper Smet <josbeir@gmail.com>
1 parent 21f8829 commit 7bd5971

121 files changed

Lines changed: 638 additions & 42 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/en/appendices.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "Appendices"
3+
description: "CakePHP appendices: access migration guides, glossary, upgrade paths, development process info, and version-specific documentation."
4+
---
5+
16
# Appendices
27

38
Appendices contain information regarding the new features

docs/en/appendices/5-0-migration-guide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "5.0 Migration Guide"
3+
description: "Upgrade to CakePHP 5.0: migrate from 4.x, handle breaking changes, update code, understand new requirements and deprecation removals."
4+
---
5+
16
# 5.0 Migration Guide
27

38
CakePHP 5.0 contains breaking changes, and is not backwards compatible with 4.x

docs/en/appendices/5-0-upgrade-guide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "5.0 Upgrade Guide"
3+
description: "Upgrade to CakePHP 5.0 from 4.x. Fix deprecations, update to PHP 8.1+, run rector tool, and update dependencies following this step-by-step guide."
4+
---
5+
16
# 5.0 Upgrade Guide
27

38
First, check that your application is running on latest CakePHP 4.x version.

docs/en/appendices/5-1-migration-guide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "5.1 Migration Guide"
3+
description: "Migrate to CakePHP 5.1: explore new features, deprecations, improvements, and upgrade your 5.0 application with this comprehensive guide."
4+
---
5+
16
# 5.1 Migration Guide
27

38
The 5.1.0 release is backwards compatible with 5.0. It adds new functionality

docs/en/appendices/5-2-migration-guide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "5.2 Migration Guide"
3+
description: "Migrate to CakePHP 5.2: understand new features, deprecations, breaking changes, and upgrade your application from 5.0/5.1 smoothly."
4+
---
5+
16
# 5.2 Migration Guide
27

38
The 5.2.0 release is backwards compatible with 5.0. It adds new functionality

docs/en/appendices/5-3-migration-guide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "5.3 Migration Guide"
3+
description: "Upgrade to CakePHP 5.3: discover new features, deprecations, improvements, and migrate from 5.0-5.2 with this detailed guide."
4+
---
5+
16
# 5.3 Migration Guide
27

38
The 5.3.0 release is backwards compatible with 5.0. It adds new functionality

docs/en/appendices/cakephp-development-process.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "CakePHP Development Process"
3+
description: "Understand CakePHP development: release cycles, semantic versioning, contribution workflow, and how the framework evolves over time."
4+
---
5+
16
# CakePHP Development Process
27

38
CakePHP projects broadly follow [semver](https://semver.org/). This means that:

docs/en/appendices/glossary.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,34 @@
1-
# Glossary
1+
---
2+
title: "Glossary"
3+
description: "CakePHP terminology reference: understand common abbreviations, technical terms, and framework-specific vocabulary used in documentation."
4+
---
25

3-
<div class="glossary">
6+
# Glossary
47

5-
CDN
8+
## CDN
69
Content Delivery Network. A 3rd party vendor you can pay to help
710
distribute your content to data centers around the world. This helps
811
put your static assets closer to geographically distributed users.
912

10-
columns
13+
## columns
1114
Used in the ORM when referring to the table columns in an database
1215
table.
1316

14-
CSRF
17+
## CSRF
1518
Cross Site Request Forgery. Prevents replay attacks, double
1619
submissions and forged requests from other domains.
1720

18-
DI Container
21+
## DI Container
1922
In `Application::services()` you can configure application services
2023
and their dependencies. Application services are automatically injected
2124
into Controller actions, and Command Constructors. See
2225
[Dependency Injection](../development/dependency-injection).
2326

24-
DSN
27+
## DSN
2528
Data Source Name. A connection string format that is formed like a URI.
2629
CakePHP supports DSNs for Cache, Database, Log and Email connections.
2730

28-
dot notation
31+
## dot notation
2932
Dot notation defines an array path, by separating nested levels with `.`
3033
For example:
3134

@@ -43,17 +46,17 @@ Would point to the following value:
4346
]
4447
```
4548

46-
DRY
49+
## DRY
4750
Don't repeat yourself. Is a principle of software development aimed at
4851
reducing repetition of information of all kinds. In CakePHP DRY is used
4952
to allow you to code things once and re-use them across your
5053
application.
5154

52-
fields
55+
## fields
5356
A generic term used to describe both entity properties, or database
5457
columns. Often used in conjunction with the FormHelper.
5558

56-
HTML attributes
59+
## HTML attributes
5760
An array of key => values that are composed into HTML attributes. For example:
5861

5962
``` php
@@ -75,15 +78,15 @@ can be used:
7578
checked="checked"
7679
```
7780

78-
PaaS
81+
## PaaS
7982
Platform as a Service. Platform as a Service providers will provide
8083
cloud based hosting, database and caching resources. Some popular
8184
providers include Heroku, EngineYard and PagodaBox
8285

83-
properties
86+
## properties
8487
Used when referencing columns mapped onto an ORM entity.
8588

86-
plugin syntax
89+
## plugin syntax
8790
Plugin syntax refers to the dot separated class name indicating classes
8891
are part of a plugin:
8992

@@ -95,18 +98,16 @@ are part of a plugin:
9598
'AcmeCorp/Tools.Toolbar'
9699
```
97100

98-
routes.php
101+
## routes.php
99102
A file in the `config/` directory that contains routing configuration.
100103
This file is included before each request is processed.
101104
It should connect all the routes your application needs so
102105
requests can be routed to the correct controller + action.
103106

104-
routing array
107+
## routing array
105108
An array of attributes that are passed to `Router::url()`.
106109
They typically look like:
107110

108111
``` php
109112
['controller' => 'Posts', 'action' => 'view', 5]
110113
```
111-
112-
</div>

docs/en/appendices/migration-guides.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "Migration Guides"
3+
description: "Upgrade CakePHP versions: follow migration guides for each release, understand breaking changes, and smoothly transition between versions."
4+
---
5+
16
# Migration Guides
27

38
Migration guides contain information regarding the new features introduced in

docs/en/appendices/phpunit-upgrade.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: "PHPUnit Upgrade"
3+
description: "Upgrade PHPUnit in CakePHP 5.x: migrate tests to PHPUnit 11+, update assertions, configure test suites, and maintain compatibility."
4+
---
5+
16
# PHPUnit Upgrade
27

38
This guide covers the PHPUnit version requirements and migration steps for CakePHP 5.x applications.

0 commit comments

Comments
 (0)