📚 Documentation: Upgrade Instructions Unclear

[stnguyen90]

💭 Description

Despite the Upgrade docs saying:

The first step is to install the latest version of Appwrite. Head to the directory where you first installed Appwrite. This is where you will find the appwrite directory and the appwrite/docker-compose.yml file. Make sure you are at the same level as the appwrite directory and then execute the following command

I had 2 instances today where people had confusion about where to run the upgrade command.

basatS7T said:

Yep, I saw that. It is not clear to me at this point what that says

godfather said:

ohh cool, one question i have to run update command inside appwrite directory (i.e. which has docker-compose.yml file)?

basatS7T suggested to include example paths to help clarify.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

[eldadfux]

Created a PR here: https://github.com/appwrite/docs/pull/133/files I hope it makes things more clear.

[stnguyen90]

I like this change. @eldadfux, what are your thoughts on adding examples to show that appwrite should be in the current directory?

[eldadfux]

@stnguyen90 did you had any snippet in mind?

[stnguyen90]

The user probably wanted to see something like this:

/path/to/parent/of/appwrite $ docker run -it --rm \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
    --entrypoint="install" \
    appwrite/appwrite:0.12.1

but this doesn't match the convention of any of the other example commands so I don't think this should be done.

Perhaps the docs could be updated to:

Head to the directory where you first installed Appwrite. This is the parent directory, where you will find the appwrite directory.

ls appwrite

Verify that shows the docker-compose.yml and .env files. Then, install the latest version of Appwrite.

docker run -it --rm \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
    --entrypoint="install" \
    appwrite/appwrite:0.12.1

Otherwise, the one-liner can check for the appwrite folder before installing:

[ -d "appwrite" ] && docker run -it --rm \
    --volume /var/run/docker.sock:/var/run/docker.sock \
    --volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
    --entrypoint="install" \
    appwrite/appwrite:0.12.1

[stnguyen90]

After talking internally, we decided to create a separate upgrade command that would validate the existing installation before proceeding. It could even check to ensure you're upgrading to the next version of Appwrite rather than skipping versions.

[stnguyen90]

Related PRs:

• Feat upgrade task #6068
• Feat upgrade task #5874