Skip to content

Modernize Installation Guide#8168

Merged
josbeir merged 6 commits into5.xfrom
clean-up-installation
Jan 28, 2026
Merged

Modernize Installation Guide#8168
josbeir merged 6 commits into5.xfrom
clean-up-installation

Conversation

@josbeir
Copy link
Contributor

@josbeir josbeir commented Jan 27, 2026

Updates installation.md with VitePress features and removes dated content:

Changes:

  • Add frontmatter (title, description) for SEO
  • Replace blockquotes with modern VitePress callouts (::: tip, ::: warning, ::: danger, ::: info)
  • Add code groups for multi-platform instructions (Linux/macOS/Windows, Composer/DDEV/Docker)
  • Remove outdated references (XAMPP, WAMP, Lighttpd, NGINX Unit, virtualhostx)
  • Remove Oracle database mentions
  • Streamline web server configs (Apache, nginx, Caddy, IIS)
  • Add modern Caddy server configuration
  • Simplify directory structure visualization
  • Improve visual hierarchy and scannability
  • Add "Next Steps" section with clear links

The guide is now more maintainable, easier to navigate, and better aligned with modern development workflows.

Copilot AI review requested due to automatic review settings January 27, 2026 16:04
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the CakePHP installation documentation to use VitePress-native formatting and modernized setup guidance.

Changes:

  • Adds page frontmatter and restructures the guide for improved scannability.
  • Replaces legacy blockquotes with VitePress callouts and introduces code groups for platform/tool variants.
  • Refreshes deployment/web server guidance (including a new Caddy example) and removes outdated references.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

josbeir and others added 2 commits January 27, 2026 17:15
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
::: tip Stay Updated
Your `composer.json` version constraint controls updates:
- `"cakephp/cakephp": "5.0.*"` - Patch releases only
- `"cakephp/cakephp": "^5.0"` - Minor + patch releases (recommended)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't recommend auto bumping to minor. It should be a more conscious decision. While API maintains BC sometimes config/bootstrap tweaks are required to the app when bumping up a minor.

That is why our skeleton also has patch release level constraint.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so how do you propose we document this ?

Just like this: ?

- `"cakephp/cakephp": "5.0.*"` - Patch releases only (recommended)
- `"cakephp/cakephp": "^5.0"` - Minor + patch releases (may require config changes)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that seems okay

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we don't recommend it, why do we have it in our app template then? 😁

Copy link
Member

@ADmad ADmad Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As of 5.2 it was patch releases only https://github.com/cakephp/app/blob/5.2.0/composer.json#L9. I don't know why it was changed for 5.3.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

now we are consistent 👍🏻
@josbeir please adjust it to like you said above (recommended patch releases)

Copy link
Member

@markstory markstory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@josbeir josbeir merged commit 8ad713d into 5.x Jan 28, 2026
4 checks passed
@josbeir josbeir deleted the clean-up-installation branch January 28, 2026 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants