docs: align getting-started with the api-platform CLI installer#2297
Merged
Conversation
The api-platform/api-platform repository becomes a CLI installer that scaffolds projects, replacing the downloadable distribution archive (the bundled Docker app, the PWA skeleton and the Helm chart). - symfony/index.md: rewrite the install section around the `api-platform` binary. Update the services/components tables (the Next.js PWA now runs as a standalone app, the admin as a separate SPA), the demo resource (Greetings ApiResource), and repoint template-sync to dunglas/symfony-docker - laravel/index.md: add the CLI installer as the recommended entry point, keep the manual composer/artisan flow for existing projects - deployment/kubernetes.md, minikube.md, *testing.md: the Helm chart is no longer bundled; point to the chart preserved at the v4.1 tag - core/*, symfony/*, create-client/*, schema-generator/*, laravel/*: replace stale "the distribution" wording with "the API Platform Symfony variant" / "the Docker setup"; repoint dead installer-repo CI links to api-platform/demo
soyuka
force-pushed
the
docs/cli-installer-scaffold
branch
from
d34816f to
bed10f5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The
api-platform/api-platformrepository is becoming a CLI installer (feat/cli-scaffold) that scaffolds new projects, replacing the downloadable distribution archive (the bundled Docker app, the PWA skeleton and the Helm chart). This PR aligns the documentation with that change.Changes
Getting started (critical)
symfony/index.md— rewrite the install section around theapi-platformbinary (static binary from Releases, orcomposer global require api-platform/installer). Recommended command:api-platform bookshop-api --framework=symfony --with-docker --with-pwa --with-admin, which keeps theapi/sibling layout the rest of the tutorial relies on. Updated::3000(not part of the Compose stack), the admin as a separate React-admin SPA on:5173src/ApiResource/Greetings.php(a plain API resource), not a DoctrineGreetingentitydunglas/symfony-docker(the actual upstream of the scaffolded Docker config)laravel/index.md— add the CLI installer as the recommended entry point; keep the manualcomposer require+php artisan api-platform:installflow for existing projects.Helm / Kubernetes
The Helm chart is no longer bundled by the installer.
deployment/kubernetes.md— neutral note that the chart is no longer bundled (rework in progress), pointing to the chart preserved at thev4.1.0tag; guide kept.minikube.md,symfony/testing.md,laravel/testing.md— fixed "Helm chart provided with the distribution" wording.Terminology pass
Replaced ~30 stale "the distribution" references with "the API Platform Symfony variant" / "the Docker setup" across
core/*,symfony/*,create-client/nextjs.md,schema-generator/getting-started.md,laravel/*. Repointed dead installer-repo CI links toapi-platform/demo.Notes / to confirm
api-platform-linux-x86_64(from the installer README); verify the release workflow publishes that exact asset name.symfony/index.mdstill show the old unified-Caddy welcome / PWA screens — may want reshooting later (not blocking).Linting (markdownlint + prettier) passes on all changed files.