From 827ec1b63acbd4c5fce2eebd9a6d6fa0530440f6 Mon Sep 17 00:00:00 2001 From: Richard Salame Date: Thu, 13 Jun 2024 19:53:02 +0530 Subject: [PATCH] chore(doc): update quick-start.mdx (#10276) Update quick-start.mdx The following changes are made: - Changed the headings to capital case. - Changed a few sentences to sound more clear. - Removed '?' from the heading as per the standards. --- docs/docs/overview/quick-start.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/docs/overview/quick-start.mdx b/docs/docs/overview/quick-start.mdx index 9998832770..e352757a0f 100644 --- a/docs/docs/overview/quick-start.mdx +++ b/docs/docs/overview/quick-start.mdx @@ -5,21 +5,21 @@ sidebar_position: 3 # Quick Start Here is a quick, no-choices path to install Immich and take it for a test drive. -Once you've tried it, perhaps you'll use one of the many other ways +Once you've tried it, you might use one of the many other ways to install and use it. ## Requirements Check the [requirements page](/docs/install/requirements) to get started. -## Install and launch via Docker Compose +## Install and Launch via Docker Compose Follow the [Docker Compose (Recommended)](/docs/install/docker-compose) instructions to install the server. - Where random passwords are required, `pwgen` is a handy utility. - `UPLOAD_LOCATION` should be set to some new directory on the server - with free space. + with enough free space. - You may ignore "Step 4 - Upgrading". ## Try the Web UI @@ -48,26 +48,26 @@ import MobileAppLogin from '/docs/partials/_mobile-app-login.md'; In the mobile app, you should see the photo you uploaded from the web UI. -### Transfer Photos from your Mobile Device +### Transfer Photos from Your Mobile Device import MobileAppBackup from '/docs/partials/_mobile-app-backup.md'; -Depending on how many photos are on your mobile device, this backup may +The backup time differs depending on how many photos are on your mobile device. Large uploads may take quite a while. -You can select the Jobs tab to see Immich processing your photos. +You can select the **Jobs** tab to see Immich processing your photos. -## Set up your backups +## Set up Your Backups You may want to back up the content of your Immich instance along with other parts of your server; be sure to read about [database backup](/docs/administration/backup-and-restore). -## Where to go from here? +## Where to Go From Here You may decide you'd like to install the server a different way; the Install category on the left menu provides many options.