Skip to content

Developing Sourcegraph Getting Started Section steps can be rearranged

Created by: lyqht

Describe the issue

I'm a user that would like to start up Sourcegraph on a MacOS using Docker.

Problem 1

While following the steps on Developing Sourcegraph document under the Getting Started section, I realize that Step 6: Install sg should come first before Step 4: Initialize your database.

This is because in Step 4, we are asked to use sg run redis-postgres. Before reaching Step 6, this will give command not found.

Problem 2

When I reach Step 7, there is a instruction for me to run sg start redis-postgres after creating sg.config.overwrite.yaml, but when I did that, I get an error

~/h/sourcegraph main > sg start redis-postgres 11s direnv packer 1.6.6 12:38:10
ERROR: commandset "redis-postgres" not found :(
USAGE
  sg start [commandset]

Runs the given commandset.

If no commandset is specified, it starts the commandset with the name 'default'.

Use this to start your Sourcegraph environment!

AVAILABLE COMMANDSETS IN sg.config.yaml
  api-only
  batches 🦡
  core-app
  dotcom
  enterprise
  enterprise-codeinsights
  enterprise-codeintel 🧠
  monitoring
  monitoring-alerts
  oss

The correct command here to run here is what is given in Step 4: sg run redis-postgres

Problem 3

In Step 7, when I run sg start, I got the following error.

ERROR: dev-private repository not found!
It's expected to exist at: /Users/lyqht/hacktoberfest/dev-private
See the documentation for how to clone it: https://docs.sourcegraph.com/dev/getting-started/quickstart_2_clone_repository

If you know what you're doing and want disable the check, add the following to /Users/lyqht/hacktoberfest/sourcegraph/sg.config.overwrite.yaml:

  commandsets:
    enterprise:
      requiresDevPrivate: false

The hint given here is confusing me because in Step 2, it was mentioned that the sourcegraph/dev-private repository is only required to be clone IF i am Sourcegraph employee ( which I am not ). Added the suggested portion to the sg.config.overwrite.yaml but it didn't work as well. It gives me instead

> sg start
WARNING: no commands to run

Where is the issue located?

https://github.com/sourcegraph/sourcegraph/blob/main/doc/dev/index.md#getting-started

Suggested resolution

  1. To place install sg instructions before intializing the database.
  2. In Step 7, replace sg start redis-postgres with sg run redis-postgres
  3. I'm not sure how to address Problem 3