artin/sourcegraph
1
0
Fork 0
mirror of https://github.com/sourcegraph/sourcegraph.git synced 2026-02-06 20:51:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move "install sg" step up in quickstart (#25829)

Browse Source 
This addresses the first problem in #25774 and also makes it easier for
us in the future to absorb the follow-up steps into `sg`, because `sg`
is then the first thing that's installed.
This commit is contained in:
Thorsten Ball 2021-10-08 11:20:37 +02:00 committed by GitHub
parent bcf3c2c2b9
commit d3aaee6e38
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -37,13 +37,13 @@ The fastest way to run Sourcegraph self-hosted is with the Docker container. See
### Sourcegraph OSS
1. Clone this repository
1. [Install dependencies](doc/dev/getting-started/quickstart_1_install_dependencies.md)
1. [Ensure Docker is running](doc/dev/getting-started/quickstart_3_start_docker.md)
1. [Initialize the PostgreSQL database](doc/dev/getting-started/quickstart_4_initialize_database.md)
1. [Configure the HTTPS reverse proxy](doc/dev/getting-started/quickstart_5_configure_https_reverse_proxy.md)
1. [Install `sg`](doc/dev/getting-started/quickstart_6_install_sg.md)
1. [Start the development server](doc/dev/getting-started/quickstart_6_start_server.md)
1. Clone this repository
1. [Install `sg`](doc/dev/getting-started/quickstart_3_install_sg.md)
1. [Ensure Docker is running](doc/dev/getting-started/quickstart_4_start_docker.md)
1. [Initialize the PostgreSQL database](doc/dev/getting-started/quickstart_5_initialize_database.md)
1. [Configure the HTTPS reverse proxy](doc/dev/getting-started/quickstart_6_configure_https_reverse_proxy.md)
1. [Start the development server](doc/dev/getting-started/quickstart_7_start_server.md)
```sh
sg start oss
```

2
doc/dev/background-information/postgresql.md
View File

@ -19,7 +19,7 @@ can make global configuration changes, such as changing the timezone. If you
need to use other settings for other databases, use a separate PostgreSQL
instance.
See the [setting up PostgreSQL guide](../getting-started/configure_postgresql.md) or [quickstart step 4: initialize the database](../getting-started/quickstart_4_initialize_database.md)
See the [setting up PostgreSQL guide](../getting-started/configure_postgresql.md) or [quickstart step 4: initialize the database](../getting-started/quickstart_5_initialize_database.md)
## Migrations

2
doc/dev/background-information/web/web_app.md
View File

@ -12,7 +12,7 @@ Also, check out the web app [README](https://github.com/sourcegraph/sourcegraph/
The `sg` CLI tool is required for key local development commands. Check out the `sg` [README](https://github.com/sourcegraph/sourcegraph/blob/main/dev/sg/README.md).
To install it, [see the instructions](../../getting-started/quickstart_6_install_sg.md).
To install it, [see the instructions](../../getting-started/quickstart_3_install_sg.md).
### Commands

2
doc/dev/getting-started/configure_postgresql.md
View File

@ -1,6 +1,6 @@
# Configure PostgreSQL
TODO: Can this be deprecated and/or combined in favor of [quickstart step 4](quickstart_4_initialize_database.md)?
TODO: Can this be deprecated and/or combined in favor of [quickstart step 5](quickstart_5_initialize_database.md)?
## Initialize

8
doc/dev/getting-started/index.md
View File

@ -6,9 +6,9 @@ Have a look around, our code is on [GitHub](https://sourcegraph.com/github.com/s
- [Step 1: Install dependencies](quickstart_1_install_dependencies.md)
- [Step 2: Get the code](quickstart_2_clone_repository.md)
- [Step 3: Start Docker](quickstart_3_start_docker.md)
- [Step 4: Initialize your database](quickstart_4_initialize_database.md)
- [Step 5: Configure HTTPS reverse proxy](quickstart_5_configure_https_reverse_proxy.md)
- [Step 6: Install `sg`](quickstart_6_install_sg.md)
- [Step 3: Install `sg`](quickstart_3_install_sg.md)
- [Step 4: Start Docker](quickstart_4_start_docker.md)
- [Step 5: Initialize your database](quickstart_5_initialize_database.md)
- [Step 6: Configure HTTPS reverse proxy](quickstart_6_configure_https_reverse_proxy.md)
- [Step 7: Start the server](quickstart_7_start_server.md)
- [Step 8: Additional resources](quickstart_8_additional_resources.md)

2
doc/dev/getting-started/quickstart_2_clone_repository.md
View File

@ -20,4 +20,4 @@ It needs to be cloned into the same folder as `sourcegraph/sourcegraph`, so they
> NOTE: Ensure that you periodically pull the latest changes from [`sourcegraph/dev-private`](https://github.com/sourcegraph/dev-private) as the secrets are updated from time to time.
[< Previous](quickstart_1_install_dependencies.md) | [Next >](quickstart_3_start_docker.md)
[< Previous](quickstart_1_install_dependencies.md) | [Next >](quickstart_3_install_sg.md)

4
doc/dev/getting-started/quickstart_6_install_sg.md → doc/dev/getting-started/quickstart_3_install_sg.md
View File

@ -1,4 +1,4 @@
# Quickstart step 6: Install `sg`
# Quickstart step 3: Install `sg`
At Sourcegraph we use [`sg`](https://github.com/sourcegraph/sourcegraph/tree/main/dev/sg), the Sourcegraph developer tool, to manage our local developer environment.
@ -25,4 +25,4 @@ To install `sg`, do the following:
See the [`sg` README](https://github.com/sourcegraph/sourcegraph/tree/main/dev/sg) for more information or ask in the `#dev-experience` Slack channel.
<!-- omit in toc -->
[< Previous](quickstart_5_configure_https_reverse_proxy.md) | [Next >](quickstart_7_start_server.md)
[< Previous](quickstart_2_clone_repository.md) | [Next >](quickstart_4_start_docker.md)

4
doc/dev/getting-started/quickstart_3_start_docker.md → doc/dev/getting-started/quickstart_4_start_docker.md
View File

@ -1,4 +1,4 @@
# Quickstart step 3: Start Docker
# Quickstart step 4: Start Docker
## macOS
@ -34,4 +34,4 @@ If you have issues running Docker, try [adding your user to the docker group][do
[dockerGroup]: https://stackoverflow.com/a/48957722
[socketPermissions]: https://stackoverflow.com/a/51362528
[< Previous](quickstart_2_clone_repository.md) | [Next >](quickstart_4_initialize_database.md)
[< Previous](quickstart_3_install_sg.md) | [Next >](quickstart_5_initialize_database.md)

4
doc/dev/getting-started/quickstart_4_initialize_database.md → doc/dev/getting-started/quickstart_5_initialize_database.md
View File

@ -1,4 +1,4 @@
# Quickstart step 4: Initialize your database
# Quickstart step 5: Initialize your database
## With Docker
@ -80,4 +80,4 @@ For more information about data storage, [read our full PostgreSQL page](../back
Migrations are applied automatically.
[< Previous](quickstart_3_start_docker.md) | [Next >](quickstart_5_configure_https_reverse_proxy.md)
[< Previous](quickstart_4_start_docker.md) | [Next >](quickstart_6_configure_https_reverse_proxy.md)

4
doc/dev/getting-started/quickstart_5_configure_https_reverse_proxy.md → doc/dev/getting-started/quickstart_6_configure_https_reverse_proxy.md
View File

@ -1,4 +1,4 @@
# Quickstart step 5: Configure HTTPS reverse proxy
# Quickstart step 6: Configure HTTPS reverse proxy
Sourcegraph's development environment ships with a [Caddy 2](https://caddyserver.com/) HTTPS reverse proxy that allows you to access your local sourcegraph instance via `https://sourcegraph.test:3443` (a fake domain with a self-signed certificate that's added to `/etc/hosts`).
@ -46,4 +46,4 @@ Enter your Firefox master password here and proceed. See [this issue on GitHub](
You might need to restart your web browsers in order for them to recognize the certificates.
[< Previous](quickstart_4_initialize_database.md) | [Next >](quickstart_6_install_sg.md)
[< Previous](quickstart_5_initialize_database.md) | [Next >](quickstart_7_start_server.md)

2
doc/dev/getting-started/quickstart_7_start_server.md
View File

@ -66,4 +66,4 @@ sg start monitoring
```
<!-- omit in toc -->
[< Previous](quickstart_6_install_sg.md) | [Next >](quickstart_8_additional_resources.md)
[< Previous](quickstart_6_configure_https_reverse_proxy.md) | [Next >](quickstart_8_additional_resources.md)

8
doc/dev/index.md
View File

@ -13,10 +13,10 @@ A hands-on introduction for setting up your local development environment.
- [Step 1: Install dependencies](getting-started/quickstart_1_install_dependencies.md)
- [Step 2: Get the code](getting-started/quickstart_2_clone_repository.md)
- [Step 3: Start Docker](getting-started/quickstart_3_start_docker.md)
- [Step 4: Initialize your database](getting-started/quickstart_4_initialize_database.md)
- [Step 5: Configure HTTPS reverse proxy](getting-started/quickstart_5_configure_https_reverse_proxy.md)
- [Step 6: Install `sg`](getting-started/quickstart_6_install_sg.md)
- [Step 3: Install `sg`](getting-started/quickstart_3_install_sg.md)
- [Step 4: Start Docker](getting-started/quickstart_4_start_docker.md)
- [Step 5: Initialize your database](getting-started/quickstart_5_initialize_database.md)
- [Step 6: Configure HTTPS reverse proxy](getting-started/quickstart_6_configure_https_reverse_proxy.md)
- [Step 7: Start the server](getting-started/quickstart_7_start_server.md)
- [Step 8: Additional resources](getting-started/quickstart_8_additional_resources.md)