diff --git a/docs/admin/code_hosts/index.mdx b/docs/admin/code_hosts/index.mdx index 24eea5e8a..a7bdcbcec 100644 --- a/docs/admin/code_hosts/index.mdx +++ b/docs/admin/code_hosts/index.mdx @@ -1,14 +1,12 @@ # Code host connections - [Enterprise Starter](/pricing/enterprise-starter) only supports GitHub. [Enterprise](/pricing/enterprise) supports all listed code hosts. + [Enterprise Starter](/pricing/enterprise-starter) only supports GitHub.com, GitLab.com, and Bitbucket.org. [Enterprise](/pricing/enterprise) supports all listed code hosts. Available via the Web app. -Sourcegraph Enterprise Starter supports only GitHub as a code host connection. Enterprise plan can connect to all supported code hosts listed on this page. - Sourcegraph can sync repositories from code hosts and other similar services. We designate code hosts between Tier 1 and Tier 2 based on Sourcegraph's capabilities when used with those code hosts. ## Tier 1 code hosts @@ -90,9 +88,3 @@ To use Sourcegraph with self-signed TLS Certificates, update the site configurat } } ``` - -## Testing Code Host Connections - -> WARNING: Sourcegraph 4.4.0 customers are reporting a bug where the connection test is failing when Sourcegraph is running behind proxies where TCP dial cannot be used with ports 80/443. This causes repositories to stop syncing. If you're experiencing this issue, please upgrade to 4.4.1 where normal HTTP requests are used instead. - -In Sourcegraph 4.4, site administrators have the ability to test a code host connection via the site-admin UI to improve the debuggability when something goes wrong. This check confirms that Sourcegraph has the ability to connect with the respective code host via TCP dial. diff --git a/docs/admin/index.mdx b/docs/admin/index.mdx index 8d66b22ff..ef321b69b 100644 --- a/docs/admin/index.mdx +++ b/docs/admin/index.mdx @@ -7,22 +7,7 @@ -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/) -- [Best practices](/admin/deployment_best_practices) -- [Validate a Sourcegraph deployment](/admin/validation) (experimental) - -## [Upgrade Sourcegraph](/admin/updates/) - -- [Upgrade Overview](/admin/updates/) -- [Migrate to Sourcegraph](/admin/migration/) -- [Upgrading PostgreSQL](/admin/postgres#upgrading-postgresql) +Sourcegraph administration is primarily managed by site administrators, who are responsible for the 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). ## [Configure Sourcegraph](/admin/config/) @@ -31,30 +16,13 @@ Get started running Sourcegraph on-prem. - [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) - - [Adding SSL (HTTPS) to Sourcegraph with a self-signed certificate](/admin/ssl_https_self_signed_cert_nginx) - [User authentication](/admin/auth/) - [User data deletion](/admin/user_data_deletion) - [Provision users through SCIM](/admin/scim) (Beta) - [Access control](/admin/access_control/) (Beta) -- [Setting the URL for your instance](/admin/url) - [Repository permissions](/admin/permissions/) - [Batch Changes](/batch-changes/site-admin-configuration) - [Configure webhooks](/admin/config/webhooks/) -- [Scaling workers](/admin/workers) -- [PostgreSQL configuration](/admin/config/postgres-conf) - -## [Observability](/admin/observability) - -- [Monitoring guide](/admin/how-to/monitoring-guide) -- [Metrics and dashboards](/admin/observability/metrics) -- [Alerting](/admin/observability/alerting) -- [Tracing](/admin/observability/tracing) -- [Logs](/admin/observability/logs) -- [Outbound request log](/admin/observability/outbound-request-log) -- [OpenTelemetry](/admin/observability/opentelemetry) -- [Health checks](/admin/observability/health_checks) -- [Troubleshooting guide](/admin/observability/troubleshooting) ## Features diff --git a/docs/admin/self-hosted.mdx b/docs/admin/self-hosted.mdx new file mode 100644 index 000000000..40301820b --- /dev/null +++ b/docs/admin/self-hosted.mdx @@ -0,0 +1,70 @@ +# Administration + + + Supported on [Enterprise](/pricing/enterprise) plans. + + Available via the Web app. + + + +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/) +- [Best practices](/admin/deployment_best_practices) +- [Validate a Sourcegraph deployment](/admin/validation) (experimental) + +## [Upgrade Sourcegraph](/admin/updates) + +- [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/) +- [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) + - [Adding SSL (HTTPS) to Sourcegraph with a self-signed certificate](/admin/ssl_https_self_signed_cert_nginx) +- [User authentication](/admin/auth/) + - [User data deletion](/admin/user_data_deletion) +- [Provision users through SCIM](/admin/scim) (Beta) +- [Access control](/admin/access_control/) (Beta) +- [Setting the URL for your instance](/admin/url) +- [Repository permissions](/admin/permissions/) +- [Batch Changes](/batch-changes/site-admin-configuration) +- [Configure webhooks](/admin/config/webhooks/) +- [Scaling workers](/admin/workers) +- [PostgreSQL configuration](/admin/config/postgres-conf) + +## [Observability](/admin/observability) + +- [Monitoring guide](/admin/how-to/monitoring-guide) +- [Metrics and dashboards](/admin/observability/metrics) +- [Alerting](/admin/observability/alerting) +- [Tracing](/admin/observability/tracing) +- [Logs](/admin/observability/logs) +- [Outbound request log](/admin/observability/outbound-request-log) +- [OpenTelemetry](/admin/observability/opentelemetry) +- [Health checks](/admin/observability/health_checks) +- [Troubleshooting guide](/admin/observability/troubleshooting) + +## Features + +- [Analytics](/admin/analytics) (experimental) +- [Batch Changes](/batch-changes/) +- [Beta and experimental features](/admin/beta_and_experimental_features) +- [Code navigation](/code-search/code-navigation/) +- [Pings](/admin/pings) +- [Enterprise pricing and licenses](/admin/subscriptions/) +- [Search](/admin/search) +- [Usage statistics](/admin/usage_statistics) +- [User feedback surveys](/admin/user_surveys) +- [Audit logs](/admin/audit_log) diff --git a/docs/integration/index.mdx b/docs/integration/index.mdx index 415ec722f..3987dd4eb 100644 --- a/docs/integration/index.mdx +++ b/docs/integration/index.mdx @@ -16,9 +16,8 @@ Sourcegraph integrates with your other tools to help you search, navigate, and r - Launcher extensions - [Sourcegraph for Raycast](https://www.raycast.com/bobheadxi/sourcegraph) (unofficial): search code, browse notebooks, and manage batch changes from the Raycast launcher -- IDE Extensions +- Cody IDE Extensions - [JetBrains](/integration/jetbrains) - - [Manual testing](/integration/jetbrains/manual_testing) - - [VS Code](/integration/vscode) + - [VS Code](/cody/clients/install-vscode) ![GitHub pull request integration](https://storage.googleapis.com/sourcegraph-assets/code-graph/docs/github-pr.png) diff --git a/docs/integration/jetbrains.mdx b/docs/integration/jetbrains.mdx new file mode 100644 index 000000000..66ae99972 --- /dev/null +++ b/docs/integration/jetbrains.mdx @@ -0,0 +1,3 @@ +# JetBrains plugin + +- See user docs at [jetbrains/README](https://sourcegraph.com/github.com/sourcegraph/jetbrains/-/blob/README.md) diff --git a/docs/integration/jetbrains/index.mdx b/docs/integration/jetbrains/index.mdx deleted file mode 100644 index b317280d1..000000000 --- a/docs/integration/jetbrains/index.mdx +++ /dev/null @@ -1,5 +0,0 @@ -# JetBrains plugin - -- See user docs at [jetbrains/README](https://sourcegraph.com/github.com/sourcegraph/jetbrains/-/tree/README) -- See dev docs at [jetbrains/CONTRIBUTING](https://sourcegraph.com/github.com/sourcegraph/jetbrains/-/tree/CONTRIBUTING) -- [Manual test cases](/integration/jetbrains/manual_testing) diff --git a/docs/integration/jetbrains/manual_testing.mdx b/docs/integration/jetbrains/manual_testing.mdx deleted file mode 100644 index 964ff6c50..000000000 --- a/docs/integration/jetbrains/manual_testing.mdx +++ /dev/null @@ -1,152 +0,0 @@ -# JetBrains plugin manual test cases - -## Overview - -All these test scripts are written in a way so that humans can perform it, but also an E2E testing tool can run it eventually. - -Each of these test cases should be run either right after starting the IDE and opening a project, _or_ after closing and reopening a project, to make sure we have a clean state. - -### Test case format anatomy - -* The numbered items are the steps to perform in order. -* The indented bullets are assertions. - -### Performing a test manually - -If a red error notification appears at the bottom right of the IDE, that means we have a problem. - -Same if any of the assertions fail. - -If there is a problem, we should either investigate right away (typically, if a developer does the manual testing), or create an issue with the error message / specifying which test case failed, and any additional helpful context. - -### Operating systems - -We test on macOS by default, but we should also test on Windows and Linux more often. -We have three test instances to test the plugin on a Linux server, an Ubuntu Desktop machine, and on Windows Server. They are all on GCP, [here](https://console.cloud.google.com/compute/instances?cloudshell=true&project=david-veszelovszki-temp-env). -- For the Windows instance, follow [this guide](https://www.snel.com/support/how-to-connect-to-your-server-via-rdp-on-macos/) to connect, then use the login/password you find in 1Password by the name "GCP: JetBrains plugin testing Windows". - -## Test cases - -### Website-related features - -#### Preparation - -**Perforce** testing is slightly tricky because we don’t currently have a lot of Perforce code hosts added to any of our Sourcegraph instances. Try this: - -* Use [https://cse-k8s.sgdev.org/](https://cse-k8s.sgdev.org/) as your Sourcegraph URL -* Generate an access token for yourself for CSE-K8S (admin user in 1Password), set that -* Set up a Perforce client -* Set `perforce-tests.sgdev.org:1666` for the port. User is “admin”, password is in 1Password. -* Make sure your connection work, and _actually connect_ in P4V (connection didn’t work without this step in IntelliJ for me) -* Create a workspace for yourself (delete an old one if you bump into the 20-workspace limit), and include the `test-large-depot` depot -* In the JetBrains plugin settings, set the replacement string to `perforce-tests.sgdev.org:,perforce.beatrix.com:app/,.perforce,/patch/core.perforce`. -* At this point, your files should open properly in your browser. - -#### Search Selection and Open/Copy features - -1. Open a project with a file that’s under Git version control -2. Right click on editor | Sourcegraph | Search Selection on Sourcegraph Web - * Make sure it searches the current selection in all repos -3. Right click on editor | Sourcegraph | Search Selection in Repository on Sourcegraph Web - * Make sure it searches the current selection in the current repo -4. Right click on editor | Sourcegraph | Open Selection in Sourcegraph Web - * Make sure it opens the right file on the web -5. Copy Sourcegraph File Link - * Make sure it copies the right URL (should be good if the previous point worked because they share the logic.) -6. Repeat it with a Perforce repo. - -#### “Open Revision Diff in Sourcegraph Web” - -1. Open a project that has files under Git version control -2. Open Version Control (⌘9) | Log -3. Right click on a commit and choose Open Revision Diff in Sourcegraph Web -4. Make sure the right page opens on the Sourcegraph instance set up in the plugin settings -5. (Would be cool to also test this each time with a project that has files from multiple repositories.) -6. Repeat the process with a project that has files under Perforce version control. - -### Find with Sourcegraph - -#### Popup opens, loads, and closes - -Why: To make sure the popup is discoverable and generally works - -1. Press the shortcut for the popup - * The popup should become active - * The popup should be in the “loading” state -2. Wait until the “loading” state is gone - * It should not take more than ~five seconds -3. Close the popup with ESC - * The popup should become hidden -4. Open “Find Action” (⌘⇧A) and search for “find with sourcegraph” and select the first result - * The popup should become active - * The popup should not be in the “loading” state -5. Click the header of the IDE main window - * The popup should become hidden -6. In the main menu, choose Edit | Find | Find on Sourcegraph… - * The popup should become active - -#### Browser doesn’t disappear after a few opens - -Why: After opening and closing the "Find on Sourcegraph" popup four-five times on Mac, the browser disappears if _circumstances are not right_. This bug should be fixed, but it may reappear if we mess something up. - -1. Open popup with the shortcut - * The popup should become active -2. Wait until the “loading” state is gone -3. Close the popup with ESC -4. Open popup with the shortcut - * The popup should become active, and the browser should be visible -5. Repeat 3–4 at least five times. - -#### Search results are displayed and navigation works - -Why: To make sure that the most basic functionality of the popup works - -1. Open the popup with the shortcut -2. Wait for the browser content to load -3. Type “repo:^github\.com/sourcegraph/sourcegraph file:index.ts” - * It should type into the input box - * The content should be exactly the same as what was typed -4. Press Enter -5. Wait for the search results and preview to load - * The result list and the preview box should populate -6. Press `↓` key -7. Wait for the search results and preview to load - * The preview should be different from the previous one -8. Press `⌥Enter` - * The popup should close - * A new editor tab should open - * The content of the new tab should be the same as the last preview -9. Open the popup with the shortcut -10. Press ⌘A, type “repo:^github\.com/sourcegraph/sourcegraph” and press Enter -11. Wait for the search results to load - * The result list should update - * The preview state should be “No preview available” -12. Press ⌥Enter - * The popup should close - * A browser should open (if automated: an “open browser” trigger should be sent) - -#### Server connection success/failure is recognized - -This test needs a valid access token that can be generated at https://sourcegraph.com/users/{username}/settings/tokens - -* Open Settings with `⌘`, -* Go to Tools | Sourcegraph -* Set the URL to “[https://sourcegraph.com](https://sourcegraph.com)” -* Set the access token to a valid one - * Press Enter to save settings -* Open the popup with the shortcut -* Wait for the browser content to load. - * The search box should be visible -* Close the popup with ESC -* Open Settings with ⌘, -* Type “TEST” after the end of the valid access token. -* Press Enter to save settings -* Open the popup with the shortcut - * The search box should not be visible, an error message should appear - * The preview should be saying “No preview available” -* Close the popup with ESC -* Open Settings with ⌘, -* Remove “TEST” to again have the valid access token. -* Press Enter to save settings -* Open the popup with the shortcut - * The search box should be visible again. diff --git a/docs/integration/vscode/index.mdx b/docs/integration/vscode/index.mdx deleted file mode 100644 index b99217790..000000000 --- a/docs/integration/vscode/index.mdx +++ /dev/null @@ -1,4 +0,0 @@ -# VS Code extension - -- [See user docs](/cody/clients/install-vscode) - diff --git a/docs/tutorials/index.mdx b/docs/tutorials/index.mdx index a75ba9811..316876d10 100644 --- a/docs/tutorials/index.mdx +++ b/docs/tutorials/index.mdx @@ -1,6 +1,6 @@ # Sourcegraph Tutorials -

Explore to learn more about Sourcegaph tutorials and guides.

+

Explore to learn more about Sourcegraph tutorials and guides.

## Find Your Way Around Sourcegraph diff --git a/src/data/navigation.ts b/src/data/navigation.ts index e10320de7..d06a56582 100644 --- a/src/data/navigation.ts +++ b/src/data/navigation.ts @@ -253,12 +253,6 @@ export const navigation: NavigationItem[] = [ { title: 'Deep Search', href: '/deep-search', - sections: [ - { - title: 'Deep Search', - href: '/deep-search' - } - ] } ] }, @@ -451,11 +445,9 @@ export const navigation: NavigationItem[] = [ title: 'Sourcegraph Admin', href: '/admin', sections: [ - { title: 'Deploy', href: '/admin/deploy' }, - { title: 'Architecture', href: '/admin/architecture' }, - { title: 'Upgrade', href: '/admin/updates' }, { title: 'Configuration', href: '/admin/config' }, { title: 'Licensing', href: '/admin/licensing' }, + { title: 'Enterprise Portal', href: '/enterprise-portal' }, { title: 'Codehosts', href: '/admin/code_hosts' }, { title: 'User Authentication', href: '/admin/auth' }, { title: 'Access Control', href: '/admin/access_control' }, @@ -463,7 +455,6 @@ export const navigation: NavigationItem[] = [ title: 'Repository Permissions', href: '/admin/permissions' }, - { title: 'Observability', href: '/admin/observability' }, { title: 'Analytics', href: '/admin/analytics' }, { title: 'Executors', href: '/admin/executors' }, { title: 'FAQs', href: '/admin/faq' }, @@ -474,6 +465,16 @@ export const navigation: NavigationItem[] = [ } ] }, + { + title: 'Enterprise self-hosted', + href: '/admin/self-hosted', + sections: [ + { title: 'Deploy', href: '/admin/deploy' }, + { title: 'Architecture', href: '/admin/architecture' }, + { title: 'Upgrade', href: '/admin/updates' }, + { title: 'Observability', href: '/admin/observability' } + ] + }, { title: 'Sourcegraph Analytics', href: '/analytics', @@ -486,10 +487,6 @@ export const navigation: NavigationItem[] = [ } ] }, - { - title: 'Sourcegraph Enterprise Portal', - href: '/enterprise-portal' - }, { title: 'Sourcegraph Cloud', href: '/cloud'