-
Notifications
You must be signed in to change notification settings - Fork 117
Updates installation doc to mention dependency on v2 #201
Conversation
app/views/docs/installation.phtml
Outdated
@@ -4,6 +4,8 @@ | |||
|
|||
<p>Appwrite was designed to run well on both small and large deployment. The minimum requirements to run Appwrite is as little as <b>1 CPU core</b> and <b>2GB of RAM</b>, and an operating system that supports Docker.</p> | |||
|
|||
<p>As of version 0.14, Appwrite requires <a href="https://www.docker.com/blog/announcing-compose-v2-general-availability/" target="_blank" rel="noopener">Docker Compose Version 2</a>. To install Appwrite, make sure your Docker installation is updated to support Composer V2.</p> |
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.
The link here provides good information on compose V1 vs V2, but I'm worried this info would be too confusing to users new to Docker.
Is it also worth it to provide a direct link to how to install?
Also, by default, the new compose plugin would be executed with docker compose
but much of the docs use docker-compose
. One would need to set up some alias or something to make docker-compose
execute docker compose
. Without mentioning that or updating the rest of the docs to use docker compose
, users might get confused.
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.
So for newer versions of Docker, (I think 4.3 and above), the docker-compose
is an automatic alias for docker compose
. I don't know if we should update everything in the docs right now.
Although, I want to discuss with the team to see if we should consider providing specific versions of docker (like x.x.x+).
In terms of linking to install, I think we should provide both the install link and the post, because the post has a specific section on what to do for existing docker users (although I can't link the section, which is mildly annoying). Chances are there will be as many who already have docker installed, but are not aware of the change.
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.
There's also a thought that maybe some of this belongs in the migration guide, if the assumption is people moving to 0.14 hits this problem.
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.
So for newer versions of Docker, (I think 4.3 and above), the docker-compose is an automatic alias for docker compose.
I think that's only if Docker was installed via Docker Desktop. Otherwise, docker compose may not be installed.
There's also a thought that maybe some of this belongs in the migration guide, if the assumption is people moving to 0.14 hits this problem.
There are other pages in the docs like the environment variables and debugging that reference using docker-compose as well.
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.
Yeah this link -> https://www.docker.com/blog/announcing-compose-v2-general-availability/
Belongs in the migration guide. The installation page from Docker should be in installation.
I think I do need to update everything to docker compose
since we have linux users and most of them (I'm guessing) do not use desktop.
@Meldiron @christyjacob4 3 discussion points:
|
|
We should also update the commands we have on the homepage getting started button. |
For now, we'll be explicit about the change post 0.14 for sake of those migrating.
We can eventually remove this line as Docker Compose V2 is supposed to be the standard down the road.