Skip to content

Commit f82e7b4

Browse files
authored
Move Migration guides under 'getting started' in toc (#8307)
Move the migration guides and upgrade tool docs to 'getting started' instead of 'appendices'. These docs are an entrypoint for returing developers. I've also retitled the migrations-guide page to focus more on the upgrading process.
1 parent 0ed3aee commit f82e7b4

2 files changed

Lines changed: 37 additions & 31 deletions

File tree

.vitepress/toc_en.json

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,36 @@
5656
]
5757
}
5858
]
59+
},
60+
{
61+
"text": "Migration Guides",
62+
"collapsed": true,
63+
"items": [
64+
{
65+
"text": "Upgrading CakePHP",
66+
"link": "/appendices/migration-guides"
67+
},
68+
{
69+
"text": "5.0 Migration Guide",
70+
"link": "/appendices/5-0-migration-guide"
71+
},
72+
{
73+
"text": "5.0 Upgrade Guide",
74+
"link": "/appendices/5-0-upgrade-guide"
75+
},
76+
{
77+
"text": "5.1 Migration Guide",
78+
"link": "/appendices/5-1-migration-guide"
79+
},
80+
{
81+
"text": "5.2 Migration Guide",
82+
"link": "/appendices/5-2-migration-guide"
83+
},
84+
{
85+
"text": "5.3 Migration Guide",
86+
"link": "/appendices/5-3-migration-guide"
87+
}
88+
]
5989
}
6090
]
6191
},
@@ -367,30 +397,6 @@
367397
"text": "Appendices",
368398
"items": [
369399
{ "text": "Appendices", "link": "/appendices" },
370-
{
371-
"text": "Migration Guides",
372-
"link": "/appendices/migration-guides"
373-
},
374-
{
375-
"text": "5.0 Migration Guide",
376-
"link": "/appendices/5-0-migration-guide"
377-
},
378-
{
379-
"text": "5.0 Upgrade Guide",
380-
"link": "/appendices/5-0-upgrade-guide"
381-
},
382-
{
383-
"text": "5.1 Migration Guide",
384-
"link": "/appendices/5-1-migration-guide"
385-
},
386-
{
387-
"text": "5.2 Migration Guide",
388-
"link": "/appendices/5-2-migration-guide"
389-
},
390-
{
391-
"text": "5.3 Migration Guide",
392-
"link": "/appendices/5-3-migration-guide"
393-
},
394400
{
395401
"text": "CakePHP Development Process",
396402
"link": "/appendices/cakephp-development-process"

docs/en/appendices/migration-guides.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Migration Guides"
2+
title: "Upgrading CakePHP"
33
description: "Upgrade CakePHP versions: follow migration guides for each release, understand breaking changes, and smoothly transition between versions."
44
---
55

@@ -25,15 +25,15 @@ git checkout 5.x
2525
composer install --no-dev
2626

2727
# Run rector with the desired ruleset
28-
bin/cake upgrade rector --rules cakephp51 <path/to/app/src>
28+
bin/cake upgrade rector --rules cakephp52 <path/to/app/src>
2929
```
3030

3131
Run rector before updating your `composer.json` dependencies
3232
to ensure the tool can resolve class names correctly.
3333

34-
- [5 0 Upgrade Guide](5-0-upgrade-guide)
35-
- [5 0 Migration Guide](5-0-migration-guide)
36-
- [5 1 Migration Guide](5-1-migration-guide)
37-
- [5 2 Migration Guide](5-2-migration-guide)
38-
- [5 3 Migration Guide](5-3-migration-guide)
34+
- [5.0 Upgrade Guide](5-0-upgrade-guide)
35+
- [5.0 Migration Guide](5-0-migration-guide)
36+
- [5.1 Migration Guide](5-1-migration-guide)
37+
- [5.2 Migration Guide](5-2-migration-guide)
38+
- [5.3 Migration Guide](5-3-migration-guide)
3939
- [PHPUnit Upgrade](phpunit-upgrade)

0 commit comments

Comments
 (0)