dotnet-installer/Documentation/installation-scenarios.md
Krzysztof Wicher 3666543d24 WIP: changes 1
2016-02-16 11:57:56 -08:00

3.2 KiB

General principles that apply to the installs

  • Only HTTPS links are allowed in any online property
  • All installers are signed properly
  • All user facing materials point to the getting started page
  • The user needs extra effort to install the "bleeding edge" bits (nightly build)

Landing Pages

Getting Started Page - for customers Repo landing page - for contributors

Getting Started Page

The page can be found on https://aka.ms/dotnetcoregs.

  • Installation targets: native installers (bits) & "curl&run"
  • Source branch: rel/1.0.0
  • Links to builds: LKG ?? latest green build of rel/1.0.0 (build status)
  • Debian feed: Development
  • Installation script links: Latest from rel/1.0.0

This is the main curated first-run experience for the dotnet CLI. The intent of the page is to help users "kick the tires" quickly and become familiar with what the platform offers. This should be the most stable and curated experience we can offer. Getting started page can never point to unstable builds.

Repo Landing Page

The repo landing page can be found on: https://github.com/dotnet/cli/readme.md

  • Installation targets: native installers & "curl&run" (should be obscured by getting started link: i.e. on the bottom of the page)
  • Source branch: rel/1.0.0
  • URLs point to: latest green build of rel/1.0.0;

Download links on the landing page should be decreased in importance. First thing for "you want to get started" section should link to the getting started page on the marketing site.

The Repo Landing Page should be used primarily by contributors to the CLI. There should be a separate page that has instructions on how to install both the latest stable as well as latest development with proper warnings around it. The separate page is to really avoid the situation from people accidentally installing unstable bits (since SEO can drop them in the repo first).

Installation modes

Interactive installation (native installers)

These installation experiences are the primary way new users are getting the bits. They are aimed towards users kicking the tires. They are found using (not not limited to) the following means:

  • Web searches
  • Marketing materials
  • Presentations
  • Documentation

The primary way to get information about this mode of installation is the marketing website.

The native installers are:

  • Deb packages for Debian-based distros
  • RPM packages for RH-based distros
  • Bundles for Windows
  • PKG for OS X
  • Homebrew for OS X

Curl & paste installation script

install.sh/install.ps1

This approach will be used for the below scenarios:

  • Local installation (consumed by build scripts)
  • Global installation (consumed by users who like command line)
  • Copy & paste script: downloads and executes installation script

TODO: add actual commands for both Unix and Windows.

Docker

Docker images are used either as a base or as small development envs for trying out the bits. We should have a Docker image with stable bits done.

Acquiring through other products (VS, VS Code)

Visual Studio will chain the native installer. The version we give them is from the rel/1.0.0 branch.

VS Code extension will toast/point people to the installers (getting started page).