From a7b4727c20eb71f5abdf081d54aaf2f5c3802e41 Mon Sep 17 00:00:00 2001
From: Jon Howell <jonhnet@users.noreply.github.com>
Date: Mon, 18 Dec 2023 12:45:49 -0800
Subject: [PATCH] feat(docs): Add a linear quick-start guide (#5812)

* feat(docs): Add a linear quick-start guide

* prettier

* fix: format

* removed unused text

---------

Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
---
 docs/docs/overview/help.md                |   2 +-
 docs/docs/overview/img/upload-button.png  | Bin 0 -> 2607 bytes
 docs/docs/overview/logo.md                |   2 +-
 docs/docs/overview/quick-start.mdx        |  85 ++++++++++++++++++++++
 docs/docs/overview/support-the-project.md |   2 +-
 5 files changed, 88 insertions(+), 3 deletions(-)
 create mode 100644 docs/docs/overview/img/upload-button.png
 create mode 100644 docs/docs/overview/quick-start.mdx

diff --git a/docs/docs/overview/help.md b/docs/docs/overview/help.md
index 33a35b9b34..2c492468eb 100644
--- a/docs/docs/overview/help.md
+++ b/docs/docs/overview/help.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 4
+sidebar_position: 5
 ---
 
 # Help Me!
diff --git a/docs/docs/overview/img/upload-button.png b/docs/docs/overview/img/upload-button.png
new file mode 100644
index 0000000000000000000000000000000000000000..03b6c44bdbad08b4fb8ac1494d0074f3eaf14f14
GIT binary patch
literal 2607
zcmV+~3efe5P)<h;3K|Lk000e1NJLTq004mi002b@1^@s6ZP|tL00004b3#c}2nYxW
zd<bNS0000PbVXQnQ*UN;cVTj60B3G*ZDlQUV{&C>ZgXgFbngSdJ^%m!Ep$a#bVG7w
zVRUJ4ZXi@?ZDjycb#5RrHy}i1V<0jxGBY4BH##&iIyEyOP)#6EQ&juh#Fzj835ZEV
zK~#90?VNp7lvN(bKhF$9BQroVfD?wIU~Nf&*|v1b6)p26i_TJ8EG>nimQlV`nt8Sm
zPYbo|*>ZE&ENfde(@OUovvOTsjXAk$nd2LtB;G6;m04(H1`wEe_74V9q7|5DW)SY@
zoQHFs;km#2n|r^{y}$c1R{~@N0~%GJ9S{T_Ap(IAfk22rfDnNIAp!wH1OkKz1PBob
zfFPv}s?<RkBcsuW8_|a7QL7ctVnE??wbIn!z+tbY)@H@+YE?WB2?eK(4Uy59V&X)_
z`v{k-l{4R!Q)ja(YF9B43?4F^sOVTFObISQjkSui)s>3bQzRxZL`Dk%_>rjSSPYTT
zirMp81S)k9rkFS-d=c~jQ%oExg}Pm@MPQ7K7BN5oP<sM!CGc7V`f#HXeh7MjQf2S8
z2(%%3CHxTd0;S5{YY~X9AaE#E_F~3RAVeVOV<MO|aRMv<T!db)3$!Z(iasNPg$r_d
zW_~X5aU&=ySgM>5f|8lPZX;`FUDs)$M9b~Jdyh|EO=nm)OF=RulKEU7ImteZgH$Gd
zIdchl>BIb1IekI|3m4>a=N%I|?iCk;La47A!=#j<g!;17)WaD&C7Ecggyh3)E+pV0
zXcvIf*}$2zH2{>ASN2&U^hW|ZzPnHW&ph`6b7s%LG&qWdOY$fx$nOxs!X-;_IGnz9
zMlx~V%gdP=R>Hof7;cOWq4CraK7Q*B-aS}{yX!=RT|bps*>`d4NCVRMRqX#{J*ze!
zrOvY~7c_V@zj|;Qsfi;P8a0UX)}ws-_A1`_vbJsIPSSDxJvq!tznM6FBjtNbQTzGT
z3}{Pm=txP20LscMJ3e<foGe_DM_G9#&W1+c3*Z7&CKK#kOF_Y#Y`0%S=92lOMR#3H
zs_029S(?o_eFYz{|A4J0wA_;YEYIJ2HR|?<A`=-G*NEkl_gKDs9mURTdGM)+8LN{3
z31jLU@@J-?FZ&noeqiQw%qZeD{`$6U1hggCzGD}A_U`YplG}ygZ(0t%PtgW5PGEmo
z5b<x!X4)OGe6+5j)01lACQc<e=ol;W|HPKFGDv1l>t5x_X?Jk#)-@b&h1QaF%v~TO
ztJJ7v7sa+{QeGU*&tg=VPed~QuAieX`+$W7o2YUDA624R`vl6Z5nh^rPxt-5w_MQ{
zK<XT3dG0&!rf|DEnts_{#@DAIY3L9%RB-X0o?wQ>nvlOUbI9f~BG+-~(6`8mF$^0d
zalBq8XvnS1e&Qh}-w=h?RnN(j4)l_SU=5&-CU%I#e~U{v<?@(qX{OoFzYYz!2z<|Z
znwlU)A98WuC+P^)Nzm9p!%r5v3bh(Q?qcVSjNC=K_LyD<P(_nAKbL9Y2l#u@8+_BG
zW7se5=HcO2{$K-8sRA3H`z`nQxZxBP<}+v3^j_PTG;sn&h51aHIN{O{x8piRX=O9I
zq+1vh`a^4=zUpRf8!1s!Udi_tRHig2gb>eTs=)~)nV|Y)H9y|j*TT0|R*1QQ<Va5f
z$v{$a4AR+?oNSOmJ%spJ73DiN@S)klS6_V2)*Z)w$j@cvWVMVjF_}0|93WkxMeDDz
zp$EUU1bUs0<irG|A2rL}$22&K<irFHA34_jL~=cQw(O#M*;Jl=S<lY@lwl9LiW^gJ
zBf(w5%1=*RRKc30-|~m&W7vJ7nYh%+jA}W`ik(%s=v-JX%6D$($UQmaEPWc&u5#p&
zW4ZfAIJWxVoNxj1Daxy4CQNyRN1S`GUJ=W!Qzmh>>KtDJ$TbvixA4%sG+xLX#HWWE
ziMj1gQi7qf*QL~R20(WJjfdCp-0vOC{LOf7PalKURZsQTyIHa3UACUOc<|Ty^?ts(
z;wJ8UAdIGO5AwGc-(>6QuKNqO^`8_h3uaEvT};co33pv3d*6A9Ra>gt;tKa^K6>qS
zhCZ3Wy|ZR={&XpOzOZoS?)IHnGPa$6WvO8nxoNla&~;8qKR-h0uoV0`K=68_X~IpZ
z-FhxLF@d7Od=4Ki;hDuR^eV5c%m>KIe1Ns<-)HUm_j_gIC-KY^Oh5M*e*L1EMrE!0
zjAI8r^V){rTLN9kAd+qv)vL6o!BGl(BLF{&;Lwp{IGqi|$Bp2RFD>)RR*zzWZsVe^
z^fT6cQNnp2SntdDtvi6W5kmUC(=eG#y~@ksaI$Cbezxz})vNUV5hc0<zluPhJW7Zl
z;H!v&z#~K;5F!vLAOe>Uekv{K9!izH*CJ?Ya46wNpF*Pv;+psoXf%C$LRG1<_xf8p
z?6v4Zue|hwmjSXYbIr&Rta`182B(8TAvzwLyNJ?nD!f|r@D&bwts-{3ZV75_)_&9_
z$UHrF4x2Z9$h>*;_{Zi=JT><*`r`4=E>|nH3LRGAwFumv(=#r2WLZX*Ws;LdQCwUM
zfZ1$jbYeos|N0VVzAIPk=o&>v2X!_pHP$L6Oa&BKmI(_D#p!I@(d2MA2n!4Ca{{Qb
zRw;U9jbf3{+3HGKn$P#oGmGT*KY@)4e064#qP10LvtqBS>364>t$Aw&mcvI`@%r1e
zwzh2s^jDyG*_~e2ACP64w6wI2`}Fj54jw#6Mn(okqY;C_z_xAMc=XXnX=-W;pr^_q
zM9_)OB4{T(Je+ak#!*~cOlD>#Nl8gWL_}aVo5{?~#AdSvz*}V)up-cEwdCaFFnaW8
z%F4>vxN##D6%{`zf(r=?3uDZfF__I}va+&}Wtsc$zu!-uE6;#kJJ`H=GuheMG&D4j
zl9Ix{efyX(V@9{qo;!Dr-Me?=a=F;BVFOd9O!2X|zUA_d+IqqG@#7ggb}ZAUPp7%L
z8GucjHj$f~+hbdjB=yPJ#GWu9TY>`z4zO+8HuCcF&}y{+*zI--3k%t@WlN828I4A&
ztE+wCrr#KlBB-ygCnF;Ri^al%1q(XfWLcJ3y?S+zY#EJ4tX5^m?fzy!iU7dvb~AhS
zY=VP>nLK%Nuk9EN2GJ5+&NMYOk(HH2Mn(pak&(T!5fKp~L~yxt{P=N}FJI2%k3Zh4
z^ag`LbO-%`!oor{8V#wbJ>NMkVuF4`OG^vc+1X@gXJarJdX!eg1pNq$#lkDEyuzYI
zi%_f8mrme8v;_T(f`S4p77O|L`9wrSbSq7Nm?wa?wF7Z^E=iK)#fulqHk(bZudl!8
z>I#R$5pbWq{>}{01*Gl}9v+TLrNZrYW4GG_?T*h7A`pm}Kp;dQK!`v9{14!Q1E=2v
R2nGNE002ovPDHLkV1n(n;T8Y@

literal 0
HcmV?d00001

diff --git a/docs/docs/overview/logo.md b/docs/docs/overview/logo.md
index 02936823ce..a1fc786142 100644
--- a/docs/docs/overview/logo.md
+++ b/docs/docs/overview/logo.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 3
 ---
 
 # Logo
diff --git a/docs/docs/overview/quick-start.mdx b/docs/docs/overview/quick-start.mdx
new file mode 100644
index 0000000000..88a4af6b20
--- /dev/null
+++ b/docs/docs/overview/quick-start.mdx
@@ -0,0 +1,85 @@
+---
+sidebar_position: 2
+---
+
+# 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
+to install and use it.
+
+## Requirements
+
+Check the [requirements page](../install/requirements) to get started.
+
+## Install and launch via Docker Compose
+
+Follow the [Docker Compose (Recommended)](../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.
+- You may ignore "Step 4 - Upgrading".
+
+## Try the Web UI
+
+import RegisterAdminUser from '../partials/_register-admin.md';
+
+<RegisterAdminUser />
+
+Try uploading a picture from your browser.
+
+<img src={require('./img/upload-button.png').default} title="Upload button" />
+
+## Try the Mobile UI
+
+### Download the Mobile App
+
+import MobileAppDownload from '../partials/_mobile-app-download.md';
+
+<MobileAppDownload />
+
+### Login to the Mobile App
+
+import MobileAppLogin from '../partials/_mobile-app-login.md';
+
+<MobileAppLogin />
+
+In the mobile app, you should see the photo you uploaded from the web UI.
+
+### Transfer Photos from your Mobile Device
+
+import MobileAppBackup from '../partials/_mobile-app-backup.md';
+
+<MobileAppBackup />
+
+Depending on how many photos are on your mobile device, this backup may
+take quite a while.
+
+You can select the Jobs tab to see Immich processing your photos.
+
+<img src={require('../guides/img/jobs-tab.png').default} title="Jobs tab" />
+
+## 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.
+
+You may decide you'd like to add the _rest_ of your photos from Google Photos,
+even those not on your mobile device, via Google Takeout.
+You can use [immich-go](https://github.com/simulot/immich-go) for this.
+
+You may want to
+[upload photos from your own archive](../features/command-line-interface).
+
+You may want to incorporate an immutable archive of photos from an
+[External Library](../features/libraries#external-libraries);
+there's a [Guide](../guides/external-library) for that.
+
+You may want your mobile device to
+[back photos up to your server automatically](../features/automatic-backup).
+
+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](../administration/backup-and-restore).
diff --git a/docs/docs/overview/support-the-project.md b/docs/docs/overview/support-the-project.md
index cdd458fcce..391603cecf 100644
--- a/docs/docs/overview/support-the-project.md
+++ b/docs/docs/overview/support-the-project.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 ---
 
 # Support The Project