larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Consolidate downloads text (#1288)

Browse Source 
## Description

The removes replication of information

## Type of change

- [x] 🗺️ Documentation
This commit is contained in:
Niraj Tolia 2022-10-21 09:45:23 -07:00 committed by GitHub
parent 71176ec6dc
commit c88c610e93
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 74 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/.markdownlint.json
View File

@ -10,7 +10,8 @@
"div",
"Tabs",
"TabItem",
"CodeBlock"
"CodeBlock",
"DownloadBinaries"
]
},
}

62
docs/docs/quickstart.md
View File

@ -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.
<!-- vale Vale.Spelling = NO -->
<!-- markdownlint-disable MD034 -->
<Tabs groupId="download">
<TabItem value="win" label="Windows (Powershell)">
<CodeBlock language="powershell">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="linux-arm" label="Linux - arm64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="linux-x86-64" label="Linux - x86_64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="macos-arm" label="macOS - arm64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="macos-x86-64" label="macOS - x86_64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="docker" label="Docker">
<CodeBlock language="bash">{
`docker pull ghcr.io/alcionai/corso:${Version()}`
}</CodeBlock>
</TabItem>
</Tabs>
<!-- vale Vale.Spelling = YES -->
<!-- markdownlint-enable MD034 -->
<DownloadBinaries />
## Connect to Microsoft 365

55
docs/docs/setup/_download_binary.md Normal file
View File

@ -0,0 +1,55 @@
<!-- markdownlint-disable MD034 MD041 -->
<!-- vale Vale.Spelling = NO -->
import CodeBlock from '@theme/CodeBlock';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import {Version} from '@site/src/corsoEnv';
<Tabs groupId="download">
<TabItem value="win" label="Windows (Powershell)">
<CodeBlock language="powershell">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="linux-arm" label="Linux - arm64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="linux-x86-64" label="Linux - x86_64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="macos-arm" label="macOS - arm64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="macos-x86-64" label="macOS - x86_64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
</Tabs>
<!-- vale Vale.Spelling = YES -->
<!-- markdownlint-enable MD034 MD041 -->

74
docs/docs/setup/download.md
View File

@ -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).
<DownloadBinaries />
## 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
<Tabs groupId="docker">
<TabItem value="release" label="Official Release">
<CodeBlock language="bash">{
`docker pull ghcr.io/alcionai/corso:${Version()}`
}</CodeBlock>
<CodeBlock language="bash">{
`docker pull ghcr.io/alcionai/corso:${Version()}`
}</CodeBlock>
</TabItem>
<TabItem value="latest" label="Latest">
@ -41,59 +49,3 @@ with the `nightly` tag are also provided for testing but these are likely to be
</TabItem>
</Tabs>
## 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).
<!-- vale Vale.Spelling = NO -->
<!-- markdownlint-disable MD034 -->
<Tabs groupId="download">
<TabItem value="win" label="Windows (Powershell)">
<CodeBlock language="powershell">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="linux-arm" label="Linux - arm64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="linux-x86-64" label="Linux - x86_64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="macos-arm" label="macOS - arm64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
<TabItem value="macos-x86-64" label="macOS - x86_64">
<CodeBlock language="bash">{
`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`
}</CodeBlock>
</TabItem>
</Tabs>
<!-- vale Vale.Spelling = YES -->
<!-- markdownlint-enable MD034 -->