diff --git a/docs/admin/index.mdx b/docs/admin/index.mdx index 29cdf7dbc..4016848e4 100644 --- a/docs/admin/index.mdx +++ b/docs/admin/index.mdx @@ -1,32 +1,27 @@ # Administration -Administration is usually handled by site administrators are the admins responsible for deploying, managing, and configuring Sourcegraph for regular users. They have [special privileges](/admin/privileges) on a Sourcegraph instance. Check out this [quickstart guide](/admin/how-to/site-admin-quickstart) for more info on Site Administration. +Sourcegraph administration is primarily managed by site administrators, who are responsible for the deployment, management, and configuration of Sourcegraph instances for end users. For a comprehensive introduction to site administration, refer to our [quickstart guide](/admin/how-to/site-admin-quickstart). + ## [Deploy Sourcegraph](/admin/deploy/) +Get started running Sourcegraph on-prem. + - [Deployment overview](/admin/deploy/) - - [Kubernetes with Helm](/admin/deploy/kubernetes/) - - [See all deployment options](/admin/deploy/#deployment-types) - [Best practices](/admin/deployment_best_practices) -- [Using external services (PostgreSQL, Redis, S3/GCS)](/admin/external_services/) -- [Deploying Executors](/admin/executors/deploy_executors) -- [Validation](/admin/validation) (experimental) +- [Validate a Sourcegraph deployment](/admin/validation) (experimental) ## [Upgrade Sourcegraph](/admin/updates/) -> NOTE: The Sourcegraph [`migrator`](/admin/updates/migrator/migrator-operations) service can now perform upgrades across [multiple versions](/admin/updates/#multi-version-upgrades) on any instance 3.20 or later. - -- [Upgrade Sourcegraph](/admin/updates/) - - [Single-minor-version "standard" upgrades](/admin/updates/#standard-upgrades) - - [Multi-version upgrades](/admin/updates/#multi-version-upgrades) -- [Migration guides](/admin/migration/) +- [Upgrade Overview](/admin/updates/) +- [Migrate to Sourcegraph](/admin/migration/) - [Upgrading PostgreSQL](/admin/postgres#upgrading-postgresql) ## [Configure Sourcegraph](/admin/config/) - [Site Administrator Quickstart](/admin/how-to/site-admin-quickstart) - [Integrations](/integration/) -- [Adding Git repositories](/admin/repo/add) (from a code host or clone URL) +- [Add Git repositories](/admin/repo/add) (from a code host or clone URL) - [Monorepo](/admin/monorepo) - [Repository webhooks](/admin/repo/webhooks) - [HTTP and HTTPS/SSL configuration](/admin/http_https_configuration) diff --git a/docs/admin/updates/index.mdx b/docs/admin/updates/index.mdx index bbb5d598c..5497209b6 100644 --- a/docs/admin/updates/index.mdx +++ b/docs/admin/updates/index.mdx @@ -22,7 +22,7 @@ Sourcegraph releases have three digits, for example: `v5.0.3` | minor | `0` | | patch | `3` | -For more details on our release candence, refer to the [Sourcegraph handbook](https://handbook.sourcegraph.com/departments/engineering/dev/process/releases/#sourcegraph-releases). +For more details on our release cadence, refer to the [Sourcegraph handbook](https://handbook.sourcegraph.com/departments/engineering/dev/process/releases/#sourcegraph-releases). Generally, we ship a new version of Sourcegraph with new features and bug fixes monthly, followed by a patch release later that month. Major and minor releases happen less frequently and contain substantial changes to Sourcegraph. @@ -44,17 +44,17 @@ Sourcegraph has two upgrade types. **Standard** upgrades and **Multiversion** up > *Note: Patch versions don't determine upgrade type -- you should always upgrade to the latest patch.* -| From Version | To Version | Upgrade Type | Notes | -|--------------|------------|--------------|--------------------------------------| -| `v5.0.0` | `v5.1.0` | Standard | A minor version | -| `v5.0.0` | `v5.2.0` | Multiversion | Two minor versions | -| `v3.41.0` | `v3.42.2` | Standard | A minor version and patch version | -| `v5.1.0` | `v5.1.3` | Standard | Multiple patch versions | +| From Version | To Version | Upgrade Type | Notes | +|--------------|------------|--------------|------------------------------------------------------| +| `v5.0.0` | `v5.1.0` | Standard | A minor version | +| `v5.0.0` | `v5.2.0` | Multiversion | Two minor versions | +| `v3.41.0` | `v3.42.2` | Standard | A minor version and patch version | +| `v5.1.0` | `v5.1.3` | Standard | Multiple patch versions | | `v3.43.0` | `v4.0.0` | Standard | A major version change but only one absolute version | -| `v5.0.0` | `v5.2.2` | Multiversion | Two minor versions and patch | -| `v3.33.0` | `v5.2.0` | Multiversion | Major and minor | -| `v4.5.0` | `v5.0.0` | Standard | This is a major version but only one version change | -| `v4.4.2` | `v5.0.3` | Multiversion | Major, minor, and patch | +| `v5.0.0` | `v5.2.2` | Multiversion | Two minor versions and patch | +| `v3.33.0` | `v5.2.0` | Multiversion | Major and minor | +| `v4.5.0` | `v5.0.0` | Standard | This is a major version but only one version change | +| `v4.4.2` | `v5.0.3` | Multiversion | Major, minor, and patch | > *Note:* > - *Our major releases do not occur on a consistent interval, so make sure to check our changelog if you aren't certain about whether a major version is multiple minor versions away from your current version. You can also reach out to our support team [support@sourcegraph.com](mailto:support@sourcegraph.com)* @@ -78,7 +78,7 @@ It is highly recommended to: Sourcegraph upgrades take the following general form: 1. Determine if your instance is ready to Upgrade (check upgrade notes) 2. Merge the latest Sourcegraph release into your deployment manifests -3. If updating more than a single minor version, perform an [**automatic multi-version upgrade**]/admin/updates/automatic) if targeting **Sourcegraph 5.1 or later**; [manual multi-verison upgrades]/admin/updates/migrator/migrator-operations) are required if upgrading to an earlier version, which requires shutting off the instance and invoking the `migrator` container or job to perform the database rewrite and application of unfinished out-of-band migrations +3. If updating more than a single minor version, perform an [**automatic multi-version upgrade**]/admin/updates/automatic) if targeting **Sourcegraph 5.1 or later**; [manual multi-version upgrades]/admin/updates/migrator/migrator-operations) are required if upgrading to an earlier version, which requires shutting off the instance and invoking the `migrator` container or job to perform the database rewrite and application of unfinished out-of-band migrations 4. With upstream changes to your manifests merged, start the new instance > Note: For more explicit steps, specific to your deployment see the operations guides linked below.