Skip to content

Commit fa6bfef

Browse files
authored
Merge pull request #776 from teohhanhui/fix/download-tar-gz
Warn against using the `.zip` file of API Platform distribution
2 parents ec57fa1 + 9b89aef commit fa6bfef

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

distribution/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ asynchronous jobs to your APIs is straightforward.
5656

5757
## Installing the Framework
5858

59-
### Using the Official Distribution (recommended)
59+
### Using the Official Distribution (Recommended)
6060

61-
Start by [downloading the API Platform distribution](https://github.com/api-platform/api-platform/releases/latest) and extract
62-
its content.
63-
The resulting directory contains an empty API Platform project structure. You will add your own code and configuration inside
64-
it.
61+
Start by [downloading the API Platform distribution `.tar.gz` file](https://github.com/api-platform/api-platform/releases/latest).
62+
Once you have extracted its contents, the resulting directory contains the API Platform project structure. You will add your own code and configuration inside it.
63+
64+
**Note**: Try to avoid using the `.zip` file, as it may cause potential [permission](https://github.com/api-platform/api-platform/issues/319#issuecomment-307037562) [issues](https://github.com/api-platform/api-platform/issues/777#issuecomment-412515342).
6565

6666
API Platform is shipped with a [Docker](https://docker.com) setup that makes it easy to get a containerized development
6767
environment up and running. If you do not already have Docker on your computer, [it's the right time to install it](https://docs.docker.com/install/).

0 commit comments

Comments
 (0)