Merge pull request #537 from concourse/fly-install-feedback

incorporate feedback about fly install steps
concourse · Jun 12, 2024 · 8572c4e · 8572c4e
2 parents 7412014 + 8eb05b0
commit 8572c4e
Showing 1 changed file with 24 additions and 28 deletions.
diff --git a/lit/docs/getting-started/quickstart.lit b/lit/docs/getting-started/quickstart.lit
@@ -28,45 +28,41 @@
 \section{
     \title{Install Fly}
 
-    Next, install the \reference{fly-cli} by downloading it from the web UI and
-    \reference{fly-login}{login} to your local Concourse as the \code{test} user:
-
-    \titled-codeblock{Unix}{bash}{{
-    # MacOS
-    $ curl 'http://localhost:8080/api/v1/cli?arch=amd64&platform=darwin' -o fly \\
-        && chmod +x ./fly && mv ./fly /usr/local/bin/
-    # Linux
-    $ curl 'http://localhost:8080/api/v1/cli?arch=amd64&platform=linux' -o fly \\
-        && chmod +x ./fly && mv ./fly /usr/local/bin/
-
-    $ fly -t tutorial login -c http://localhost:8080 -u test -p test
-    logging in to team 'main'
+    Next, install the \reference{fly-cli} by downloading it from the web UI.
+    Following the install steps for your OS:
 
-    target saved
+    \titled-codeblock{Linux}{bash}{{
+    curl 'http://localhost:8080/api/v1/cli?arch=amd64&platform=linux' -o fly
+    chmod +x ./fly
+    mv ./fly /usr/local/bin/
     }}
 
-    \titled-codeblock{Powershell One-liner}{bash}{{{
-    # Windows (Powershell)
-    % $concoursePath = 'C:\concourse\'; mkdir $concoursePath; `
+    \titled-codeblock{MacOS}{bash}{{
+    curl 'http://localhost:8080/api/v1/cli?arch=amd64&platform=darwin' -o fly
+    chmod +x ./fly
+    mv ./fly /usr/local/bin/
+    }}
+
+    \titled-codeblock{Windows (Powershell One-liner)}{bash}{{{
+    $concoursePath = 'C:\concourse\'; mkdir $concoursePath; `
     [Environment]::SetEnvironmentVariable('PATH', "$ENV:PATH;${concoursePath}", 'USER'); `
     $concourseURL = 'http://localhost:8080/api/v1/cli?arch=amd64&platform=windows'; `
     Invoke-WebRequest $concourseURL -OutFile "${concoursePath}\fly.exe"
     }}}
 
-    \titled-codeblock{flyinstall.ps1}{bash}{{{
-    # -- Desired fly.exe location -----------
-    $concoursePath = 'C:\concourse\'
-    mkdir $concoursePath
+    Use \reference{fly-login}{\code{fly login}} to log into your local
+    Concourse as the \code{test} user:
 
-    # -- Sets User Env Variable -------------
-    [Environment]::SetEnvironmentVariable('PATH', "$ENV:PATH;${concoursePath}", 'USER')
+    \codeblock{bash}{{{
+    fly -t tutorial login -c http://localhost:8080 -u test -p test
+    }}}
 
-    # -- Sets System Env Variable -----------
-    # [Environment]::SetEnvironmentVariable("PATH", "$ENV:PATH;${concoursePath}", "MACHINE")
+    You've successfully logged in if you see the following output:
 
-    # -- Download fly.exe -------------------
-    $concourseURL = 'http://localhost:8080/api/v1/cli?arch=amd64&platform=windows'
-    Invoke-WebRequest $concourseURL -OutFile "${concoursePath}\fly.exe"
+    \codeblock{bash}{{{
+    logging in to team 'main'
+
+    target saved
     }}}
 
     You'll notice that every \code{fly} command in this tutorial has to have the