-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
fix: path references in YAML config snippets #2123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems OK to me, @dunglas do you agree?
core is the symfony-only version in a sense, I'd say that the path is fine without the api prefix.
c90713b to
01c30ed
Compare
01c30ed to
24dfb34
Compare
core is the symfony-only version in a sense, I'd say that the path is fine without the api prefix.
I agree, but I also think we should make explicit clarifications in places where the distribution version is referenced, as there are some examples where the removal of the api/ prefix may lead to misleading results.
I mean cases like these:
Line 24 in 24dfb34
Create a Heroku `app.json` file at the root of the `api/` directory to configure the deployment:Line 103 in 24dfb34
| `https://localhost/docs/` | `api/` | PHP | The API |Line 205 in 24dfb34
a Progressive Web App, you can remove the `pwa/` directory as well as the related lines in `docker-compose*.yml` and in `api/docker/caddy/Caddyfile` (don't do itdocs/distribution/debugging.md
Line 14 in 24dfb34
it's recommended to add a custom stage to the end of the `api/Dockerfile`.Line 53 in 24dfb34
You can modify the `api/docker/nginx/conf.d/default.conf` file and set values to `fastcgi_buffer_size` and `fastcgi_buffers` that suit your needs, like so:
IIUC, the only places where the api/ prefix is right is where the documentation is covering the setup for the api-platform/api-platform distribution. Other examples for use with Symfony or Laravel SHOULD NOT use the api/ prefix.
Do you agree? I'll be waiting for your feedback in order to confirm what updates to make.
AFAIK, the documentation is built around the paths from
api-platform/api-platform.api/directory references where missing;app/withapi/.