From c88c610e9315451438903f6af0897165020662d8 Mon Sep 17 00:00:00 2001 From: Niraj Tolia Date: Fri, 21 Oct 2022 09:45:23 -0700 Subject: [PATCH] Consolidate downloads text (#1288) ## Description The removes replication of information ## Type of change - [x] :world_map: Documentation --- docs/.markdownlint.json | 3 +- docs/docs/quickstart.md | 62 ++---------------------- docs/docs/setup/_download_binary.md | 55 +++++++++++++++++++++ docs/docs/setup/download.md | 74 +++++------------------------ 4 files changed, 74 insertions(+), 120 deletions(-) create mode 100644 docs/docs/setup/_download_binary.md diff --git a/docs/.markdownlint.json b/docs/.markdownlint.json index 78cadf910..29798eb90 100644 --- a/docs/.markdownlint.json +++ b/docs/.markdownlint.json @@ -10,7 +10,8 @@ "div", "Tabs", "TabItem", - "CodeBlock" + "CodeBlock", + "DownloadBinaries" ] }, } diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md index cace53fe1..6fe009339 100644 --- a/docs/docs/quickstart.md +++ b/docs/docs/quickstart.md @@ -5,6 +5,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import TOCInline from '@theme/TOCInline'; import {Version} from '@site/src/corsoEnv'; +import DownloadBinaries from './setup/_download_binary.md'; This quick start guide runs through the steps you can follow to create your first Microsoft 365 backup and restore: @@ -12,65 +13,10 @@ This quick start guide runs through the steps you can follow to create your firs ## Download Corso -Download a Corso binary or Docker image. +Download a Corso binary for your platform. If you would like to use a Docker container, the first `docker run` will +pull the image. - - - - - - -{ -`Invoke-WebRequest \` - -Uri https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Windows_x86_64.tar.gz \` - -UseBasicParsing -Outfile corso_${Version()}_Windows_x86_64.tar.gz -tar zxvf .\\corso_${Version()}_Windows_x86_64.tar.gz` -} - - - - -{ -`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Linux_arm64.tar.gz && \\ - tar zxvf corso_${Version()}_Linux_arm64.tar.gz` -} - - - - -{ -`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Linux_x86_64.tar.gz && \\ - tar zxvf corso_${Version()}_Linux_x86_64.tar.gz` -} - - - - -{ -`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Darwin_arm64.tar.gz && \\ - tar zxvf corso_${Version()}_Darwin_arm64.tar.gz` -} - - - - -{ -`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Darwin_x86_64.tar.gz && \\ - tar zxvf corso_${Version()}_Darwin_x86_64.tar.gz` -} - - - - -{ -`docker pull ghcr.io/alcionai/corso:${Version()}` -} - - - - - - + ## Connect to Microsoft 365 diff --git a/docs/docs/setup/_download_binary.md b/docs/docs/setup/_download_binary.md new file mode 100644 index 000000000..84f435ee4 --- /dev/null +++ b/docs/docs/setup/_download_binary.md @@ -0,0 +1,55 @@ + + + +import CodeBlock from '@theme/CodeBlock'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import {Version} from '@site/src/corsoEnv'; + + + + +{ +`Invoke-WebRequest \` + -Uri https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Windows_x86_64.tar.gz \` + -UseBasicParsing -Outfile corso_${Version()}_Windows_x86_64.tar.gz +tar zxvf .\\corso_${Version()}_Windows_x86_64.tar.gz` +} + + + + +{ +`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Linux_arm64.tar.gz && \\ + tar zxvf corso_${Version()}_Linux_arm64.tar.gz` +} + + + + +{ +`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Linux_x86_64.tar.gz && \\ + tar zxvf corso_${Version()}_Linux_x86_64.tar.gz` +} + + + + +{ +`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Darwin_arm64.tar.gz && \\ + tar zxvf corso_${Version()}_Darwin_arm64.tar.gz` +} + + + + +{ +`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Darwin_x86_64.tar.gz && \\ + tar zxvf corso_${Version()}_Darwin_x86_64.tar.gz` +} + + + + + + diff --git a/docs/docs/setup/download.md b/docs/docs/setup/download.md index 078ed5fba..7e945f0c0 100644 --- a/docs/docs/setup/download.md +++ b/docs/docs/setup/download.md @@ -4,13 +4,21 @@ import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import {Version} from '@site/src/corsoEnv'; +import DownloadBinaries from './_download_binary.md'; Corso is available as a Docker container image or as native binaries. +## Native binaries + +Corso is available as an `x86_64` and `arm64` executable for Windows, Linux and macOS. These can be downloaded from +the [GitHub releases page](https://github.com/alcionai/corso/releases). + + + ## Docker container images -The Corso Docker container image is available for Linux (`x86_64` and `arm64`) and this can be used on Linux, with -Docker Desktop on macOS, and on Windows in +Corso is also available as a Docker container image for Linux (`x86_64` and `arm64`). The image can also be used on +Linux, with Docker Desktop on macOS, and on Windows in [Linux Mode](https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/quick-start-windows-10-linux). These Docker containers can be pulled from [GitHub's container registry](https://github.com/alcionai/corso/pkgs/container/corso). @@ -21,9 +29,9 @@ with the `nightly` tag are also provided for testing but these are likely to be - { - `docker pull ghcr.io/alcionai/corso:${Version()}` - } +{ +`docker pull ghcr.io/alcionai/corso:${Version()}` +} @@ -41,59 +49,3 @@ with the `nightly` tag are also provided for testing but these are likely to be - -## Native binaries - -Corso is also available as an `x86_64` and `arm64` executable for Windows, Linux and macOS. These can be downloaded from -the [GitHub releases page](https://github.com/alcionai/corso/releases). - - - - - - - -{ -`Invoke-WebRequest \` - -Uri https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Windows_x86_64.tar.gz \` - -UseBasicParsing -Outfile corso_${Version()}_Windows_x86_64.tar.gz -tar zxvf .\\corso_${Version()}_Windows_x86_64.tar.gz` -} - - - - -{ -`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Linux_arm64.tar.gz && \\ - tar zxvf corso_${Version()}_Linux_arm64.tar.gz` -} - - - - -{ -`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Linux_x86_64.tar.gz && \\ - tar zxvf corso_${Version()}_Linux_x86_64.tar.gz` -} - - - - -{ -`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Darwin_arm64.tar.gz && \\ - tar zxvf corso_${Version()}_Darwin_arm64.tar.gz` -} - - - - -{ -`curl -L -O https://github.com/alcionai/corso/releases/download/${Version()}/corso_${Version()}_Darwin_x86_64.tar.gz && \\ - tar zxvf corso_${Version()}_Darwin_x86_64.tar.gz` -} - - - - - -