Skip to content

sg: document sg as default, clean up local-dev quickstart guide

Warren Gifford requested to merge mrn/document-sg-in-quickstart into main

Created by: mrnugget

This fixes https://github.com/sourcegraph/sourcegraph/issues/24964 and is the next step before we hard-deprecate ./enterprise/dev/start.sh and ./dev/start.sh this week. It can and should be merged before that.

This PR started out with me trying to document sg as the default way to run the local environment, but it ended up being a bunch of things:

  1. It adds a new section to quickstart guide that explains how to install sg
  2. It removes all mentions of ./dev/start.sh and explains how to use sg start in different incantations
  3. It cleans up the "Install depenendencies" section because the whole "With Docker" and "Without Docker" and "asdf" was a bit of a mess
  4. It moves the "clone dev-private" step from the "start environment" step to the "get the code" step (where it should be)

I think these are all necessary changes. The quickstart grew a bit over the years and it was time to trim some of it back. Once we add more functionality to sg (especially with https://github.com/sourcegraph/sourcegraph/issues/24900) it should hopefully collapse to a single page.

Anyway, here's Wonderwa a screenshot, because we all love screenshots:

sg_getting_started

Merge request reports