From 11c71b0b2609815328cbc0893b229436859bbe92 Mon Sep 17 00:00:00 2001 From: Maedah Batool Date: Thu, 24 Apr 2025 12:13:26 -0700 Subject: [PATCH] Remove mentions of old sg/sg repo --- docs/admin/auth/index.mdx | 3 +-- docs/admin/auth/saml/index.mdx | 2 +- docs/admin/beta_and_experimental_features.mdx | 2 +- docs/admin/code_hosts/github.mdx | 2 +- docs/admin/config/advanced_config_file.mdx | 2 +- docs/admin/config/batch_changes.mdx | 2 +- .../deploy/docker-single-container/index.mdx | 4 ++-- docs/admin/deploy/kubernetes/index.mdx | 2 +- docs/admin/deploy/kubernetes/upgrade.mdx | 2 +- docs/admin/deployment_best_practices.mdx | 5 +++-- .../executors/deploy_executors_terraform.mdx | 2 +- docs/admin/external_services/postgres.mdx | 2 +- docs/admin/how-to/dirty_database.mdx | 2 +- docs/admin/how-to/dirty_database_pre_3_37.mdx | 5 ++--- docs/admin/migration/3_30.mdx | 2 +- docs/admin/migration/opengrok.mdx | 4 +--- docs/admin/observability/alerts.mdx | 6 +++--- docs/admin/observability/metrics.mdx | 1 - docs/admin/observability/troubleshooting.mdx | 3 +-- docs/admin/permissions/index.mdx | 3 --- docs/admin/pings.mdx | 2 +- docs/admin/repo/perforce.mdx | 5 ++--- docs/admin/troubleshooting.mdx | 2 -- docs/admin/updates/docker_compose.mdx | 15 +++++++-------- docs/admin/updates/index.mdx | 2 +- docs/admin/updates/kubernetes.mdx | 8 ++++---- docs/admin/updates/migrator/schema-drift.mdx | 2 +- docs/admin/updates/pure_docker.mdx | 2 +- docs/admin/updates/server.mdx | 7 +++---- .../how-to/adding_scip_to_workflows.mdx | 4 ++-- .../how-to/index_other_languages.mdx | 2 +- .../search_based_code_navigation.mdx | 2 +- ...ministration_and_security_of_code_insights.mdx | 4 ++-- .../current_limitations_of_code_insights.mdx | 6 +----- ...code_insights_may_not_match_search_results.mdx | 2 -- docs/getting-started/index.mdx | 5 ----- docs/getting-started/personalization/badges.mdx | 2 +- .../browser_extension/how-tos/troubleshooting.mdx | 2 +- docs/integration/go.mdx | 2 -- 39 files changed, 53 insertions(+), 79 deletions(-) diff --git a/docs/admin/auth/index.mdx b/docs/admin/auth/index.mdx index 727539b26..7acb7390a 100644 --- a/docs/admin/auth/index.mdx +++ b/docs/admin/auth/index.mdx @@ -56,8 +56,7 @@ order: use the [OpenID Connect provider](#openid-connect). - If you wish to use LDAP and cannot use the GitHub/GitLab OAuth provider as described above, or if you wish to use another authentication mechanism that is not yet supported, please [contact - us](https://github.com/sourcegraph/sourcegraph/issues/new?template=feature_request) (we respond - promptly). + us](https://sourcegraph.com/contact) Most users will use only one auth provider, but you can use multiple auth providers if desired to enable sign-in via multiple services. Identities from different providers will be mapped to a diff --git a/docs/admin/auth/saml/index.mdx b/docs/admin/auth/saml/index.mdx index 241fcc6f7..a7afba92d 100644 --- a/docs/admin/auth/saml/index.mdx +++ b/docs/admin/auth/saml/index.mdx @@ -81,7 +81,7 @@ Error prefetching SAML service provider metadata > NOTE: Email or NameID changes in the identity provider are not automatically reflected in Sourcegraph. Admins may manually update a users email via the admin interface at `https://example-sourcegraph.com/users//settings/emails`, or remove the user and recreate a new account. > -> Work is planned to support SCIM on SAML auth providers, which should automate this process. ([tracking issue](https://github.com/sourcegraph/sourcegraph/issues/22732)) +> Work is planned to support SCIM on SAML auth providers, which should automate this process. ### How to control user sign-up and sign-in diff --git a/docs/admin/beta_and_experimental_features.mdx b/docs/admin/beta_and_experimental_features.mdx index 74ffc06b6..21720e8fe 100644 --- a/docs/admin/beta_and_experimental_features.mdx +++ b/docs/admin/beta_and_experimental_features.mdx @@ -4,7 +4,7 @@ Sourcegraph often beta tests major features before we make them generally availa Exposing beta and experimental features gives you an opportunity to try our newest features sooner. -In return, your feedback helps us make sure that our new features are reliable and useful, and we appreciate any and all feedback you want to provide. You can [file an issue](https://github.com/sourcegraph/sourcegraph/issues/new/choose), email it directly to [feedback@sourcegraph.com](mailto:feedback@sourcegraph.com), or use the in-app feedback modal. +In return, your feedback helps us make sure that our new features are reliable and useful, and we appreciate any and all feedback you want to provide. You can email us directly to [feedback@sourcegraph.com](mailto:feedback@sourcegraph.com). ## Both beta and experimental features diff --git a/docs/admin/code_hosts/github.mdx b/docs/admin/code_hosts/github.mdx index a79bdd81e..17ae78852 100644 --- a/docs/admin/code_hosts/github.mdx +++ b/docs/admin/code_hosts/github.mdx @@ -241,7 +241,7 @@ There are four fields for configuring which repositories are mirrored/synchroniz - [`repos`](/admin/code_hosts/github#repos)A list of repositories in `owner/name` format. The order determines the order in which we sync repository metadata and is safe to change. - [`orgs`](/admin/code_hosts/github#orgs)A list of organizations (every repository belonging to the organization will be cloned). -- [`repositoryQuery`](/admin/code_hosts/github#repositoryQuery)A list of strings with three pre-defined options (`public`, `affiliated`, `none`, none of which are subject to result limitations), and/or a [GitHub advanced search query](https://github.com/search/advanced). Note: There is an existing limitation that requires the latter, GitHub advanced search queries, to return [less than 1000 results](#repositoryquery-returns-first-1000-results-only). See [this issue](https://github.com/sourcegraph/sourcegraph/issues/2562) for ongoing work to address this limitation. +- [`repositoryQuery`](/admin/code_hosts/github#repositoryQuery)A list of strings with three pre-defined options (`public`, `affiliated`, `none`, none of which are subject to result limitations), and/or a [GitHub advanced search query](https://github.com/search/advanced). Note: There is an existing limitation that requires the latter, GitHub advanced search queries, to return [less than 1000 results](#repositoryquery-returns-first-1000-results-only). - [`exclude`](/admin/code_hosts/github#exclude)A list of repositories to exclude which takes precedence over the `repos`, `orgs`, and `repositoryQuery` fields. ## Rate limits diff --git a/docs/admin/config/advanced_config_file.mdx b/docs/admin/config/advanced_config_file.mdx index 347c402c5..ec08f74e4 100644 --- a/docs/admin/config/advanced_config_file.mdx +++ b/docs/admin/config/advanced_config_file.mdx @@ -119,7 +119,7 @@ When you upgrade Sourcegraph, you should do the following to ensure your configu It is essential to follow the above steps after **every** Sourcegraph version update, because we only guarantee migrations remain valid across two minor versions. If you fail to apply a migration and later upgrade Sourcegraph twice more, you may effectively "skip" an important migration. -We're planning to improve this by having Sourcegraph notify you as a site admin when you should do the above, since today it is not actually required in most upgrades. See https://github.com/sourcegraph/sourcegraph/issues/4650 for details. In the meantime, we will do our best to communicate when this is needed to you through the changelog. +We're planning to improve this by having Sourcegraph notify you as a site admin when you should do the above, since today it is not actually required in most upgrades. In the meantime, we will do our best to communicate when this is needed to you through the changelog. ## Kubernetes ConfigMap diff --git a/docs/admin/config/batch_changes.mdx b/docs/admin/config/batch_changes.mdx index abe9c6dba..16ae529d3 100644 --- a/docs/admin/config/batch_changes.mdx +++ b/docs/admin/config/batch_changes.mdx @@ -60,7 +60,7 @@ You may encounter this error when publishing changesets to GitHub: In addition to their normal API rate limits, GitHub also has an internal _content creation_ limit (also called [secondary rate limit](https://docs.github.com/en/rest/guides/best-practices-for-integrators?apiVersion=2022-11-28#dealing-with-secondary-rate-limits)), which is an [intentional](https://github.com/cli/cli/issues/4801#issuecomment-1029207971) restriction on the platform to combat abuse by automated actors. At the time of writing, the specifics of this limit remain undocumented, due largely to the fact that it is dynamically determined (see [this GitHub issue](https://github.com/cli/cli/issues/4801)). However, the behavior of the limit is that it only permits a fixed number of resources to be created per minute and per hour, and exceeding this limit triggers a temporary hour-long suspension during which time no additional resources of this type can be created. -Presently, Batch Changes does not automatically work around this limit feature request tracked [here](https://github.com/sourcegraph/sourcegraph/issues/44631). The current guidance if you do encounter this issue is to wait an hour and then try again, setting a less frequent `rolloutWindows` rate until this issue is no longer encountered. +Presently, Batch Changes does not automatically work around this limit feature request. The current guidance if you do encounter this issue is to wait an hour and then try again, setting a less frequent `rolloutWindows` rate until this issue is no longer encountered. ### Rollout window object diff --git a/docs/admin/deploy/docker-single-container/index.mdx b/docs/admin/deploy/docker-single-container/index.mdx index ab0090331..1f2d54b9a 100644 --- a/docs/admin/deploy/docker-single-container/index.mdx +++ b/docs/admin/deploy/docker-single-container/index.mdx @@ -164,7 +164,7 @@ From sourcegraph version 5.11 onwards, the Sourcegraph single container Docker i `docker run --publish 7080:7080 --publish 127.0.0.1:3370:3370 --rm --volume ~/.sourcegraph/config:/etc/sourcegraph --volume ~/.sourcegraph/data:/var/opt/sourcegraph sourcegraph/server:{CURRENT_VERSION_NO_V}` -You now have a single server Sourcegraph container image running on Postgresql 16. +You now have a single server Sourcegraph container image running on Postgresql 16. ### Standard upgrades @@ -271,7 +271,7 @@ The version of this Postgres container is dependent on the version of the instan ## Troubleshooting -If you get stuck or need help, [file an issue](https://github.com/sourcegraph/sourcegraph/issues/new?&title=Improve+Sourcegraph+quickstart+guide), [tweet (@sourcegraph)](https://twitter.com/sourcegraph) or [email](mailto:support@sourcegraph.com?subject=Sourcegraph%20quickstart%20guide). +If you get stuck or need help, please reach out to [Sourcegraph support](https://help.sourcegraph.com/hc/en-us/requests/new). ### Mac Computers with Apple silicon diff --git a/docs/admin/deploy/kubernetes/index.mdx b/docs/admin/deploy/kubernetes/index.mdx index 312e17b82..b1b1b1dd9 100644 --- a/docs/admin/deploy/kubernetes/index.mdx +++ b/docs/admin/deploy/kubernetes/index.mdx @@ -1107,7 +1107,7 @@ Some Persistent Volumes may be retained after the uninstall phase is complete. I [AWS EBS CSI driver]: https://docs.aws.amazon.com/eks/latest/userguide/managing-ebs-csi.html [NGINX Ingress Controller]: https://github.com/kubernetes/ingress-nginx [Helm Changelog]: https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph/CHANGELOG -[Sourcegraph Changelog]: https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/CHANGELOG +[Sourcegraph Changelog]: https://sourcegraph.com/changelog [Sourcegraph Migrator]: https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph-migrator [Helm Diff]: https://github.com/databus23/helm-diff [Secrets]: https://kubernetes.io/docs/concepts/configuration/secret/ diff --git a/docs/admin/deploy/kubernetes/upgrade.mdx b/docs/admin/deploy/kubernetes/upgrade.mdx index 24dfd4396..65c39c685 100644 --- a/docs/admin/deploy/kubernetes/upgrade.mdx +++ b/docs/admin/deploy/kubernetes/upgrade.mdx @@ -183,7 +183,7 @@ To perform a multi-version upgrade via migrators [upgrade](/admin/updates/migrat Execution will continue, but please report this, along with your operating system, terminal, and any other details, to: - https://github.com/sourcegraph/sourcegraph/issues/new + https://sourcegraph.com/contact ✱ Sourcegraph migrator 4.5.1 πŸ‘‰ Migrating to v3.43 (step 1 of 3) diff --git a/docs/admin/deployment_best_practices.mdx b/docs/admin/deployment_best_practices.mdx index 5e8ad400f..729f5b9d2 100644 --- a/docs/admin/deployment_best_practices.mdx +++ b/docs/admin/deployment_best_practices.mdx @@ -62,8 +62,9 @@ _It is possible to migrate your data to a Docker-Compose or Kubernetes deploymen Only the latest versions of IDEs are generally supported, but most versions within a few months up-to-date generally work. -- VS Code: [https://github.com/sourcegraph/sourcegraph/tree/main/client/vscode](https://github.com/sourcegraph/sourcegraph/tree/main/client/vscode); we don't yet support VSCodium -- JetBrains IDEs: [https://github.com/sourcegraph/sourcegraph/tree/main/client/jetbrains](https://github.com/sourcegraph/sourcegraph/tree/main/client/jetbrains) – we mainly test the plugin with IntelliJ IDEA, but it should work with no issues in all JetBrains IDEs, including: +- VS Code +- Visual Studio +- JetBrains IDEs β€” we mainly test the plugin with IntelliJ IDEA, but it should work with no issues in all JetBrains IDEs, including: - IntelliJ IDEA - IntelliJ IDEA Community Edition - PhpStorm diff --git a/docs/admin/executors/deploy_executors_terraform.mdx b/docs/admin/executors/deploy_executors_terraform.mdx index a75b3b3cd..977552332 100644 --- a/docs/admin/executors/deploy_executors_terraform.mdx +++ b/docs/admin/executors/deploy_executors_terraform.mdx @@ -410,7 +410,7 @@ Next, you can test whether the number of executors rises and shrinks as load spi ## Upgrading executors Upgrading executors is relatively uninvolved. Simply follow the instructions below. -Also, check the [changelog](https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/CHANGELOG) for any Executors related breaking changes or new features or flags that you might want to configure. See [Executors maintenance](/admin/executors/deploy_executors#Maintaining-and-upgrading-executors) for version compatability. +Also, check the [changelog](https://sourcegraph.com/changelog) for any Executors related breaking changes or new features or flags that you might want to configure. See [Executors maintenance](/admin/executors/deploy_executors#Maintaining-and-upgrading-executors) for version compatability. ### **Step 1:** Update the source version of the terraform modules diff --git a/docs/admin/external_services/postgres.mdx b/docs/admin/external_services/postgres.mdx index e943a1e54..a48e298d8 100644 --- a/docs/admin/external_services/postgres.mdx +++ b/docs/admin/external_services/postgres.mdx @@ -315,7 +315,7 @@ The first migration fails since it attempts to add `COMMENT`s to installed exten failed to run migration for schema "frontend": failed upgrade migration 1528395834: ERROR: current transaction is aborted, commands ignored until end of transaction block (SQLSTATE 25P02) ``` -In this case, locate the UP [migration 1528395834](https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/migrations/frontend/1528395834_squashed_migrations.up.sql) and apply all SQL after the final `COMMENT ON EXTENSION` command following the [dirty database procedure](/admin/how-to/dirty_database). +In this case, locate the UP migration 1528395834 and apply all SQL after the final `COMMENT ON EXTENSION` command following the [dirty database procedure](/admin/how-to/dirty_database). **Dropping the `sg_service` role** diff --git a/docs/admin/how-to/dirty_database.mdx b/docs/admin/how-to/dirty_database.mdx index b724b6aac..c0c30b9af 100644 --- a/docs/admin/how-to/dirty_database.mdx +++ b/docs/admin/how-to/dirty_database.mdx @@ -111,7 +111,7 @@ If you're running into errors such as being unable to create a unique index due - For Kubernetes: replace container args with `["add-log", "-db=", "-version="]` - For Docker-compose: replace container args with `"add-log" "-db=" "-version="` -- For local development: run `sg add-log -db= -version=` in a clone of [sourcegraph/sourcegraph](https://github.com/sourcegraph/sourcegraph) +- For local development: run `sg add-log -db= -version=` Adding this migration log entry indicates to future migrator and application instances that a complete application of the migration at that version has been run. diff --git a/docs/admin/how-to/dirty_database_pre_3_37.mdx b/docs/admin/how-to/dirty_database_pre_3_37.mdx index c51fb233e..c954fb47c 100644 --- a/docs/admin/how-to/dirty_database_pre_3_37.mdx +++ b/docs/admin/how-to/dirty_database_pre_3_37.mdx @@ -23,7 +23,7 @@ The following procedure requires that you are able to execute commands from insi _These steps pertain to the frontend database (pgsql) and are meant as a quick read for admins familiar with sql and database administration, for more explanation and details see the [detailed steps to resolution](#detailed-steps-to-resolve) below._ 1. **Check the schema version in `psql` using the following query: `SELECT * FROM schema_migrations;`. If it's dirty, note the migration's version number.** -2. **Find the up migration with that migration's version number in [https://github.com/sourcegraph/sourcegraph/tree/\/migrations/frontend](https://github.com/sourcegraph/sourcegraph/tree/main/migrations/frontend), making sure to go to \** +2. **Find the up migration with that migration's version number making sure to go to \** * _Note: migrations in this directory are specific to the `pgsql` frontend database, learn about other databases in the [detailed steps to resolution](#detailed-steps-to-resolve)_ 3. **Run the code there explicitly.** 4. **Manually clear the dirty flag on the `schema_migrations` table.** @@ -53,7 +53,7 @@ _Note: for codeintel the schema version table is called `codeintel_schema_migrat Sourcegraph's migration files take for form of `sql` files following the snake case naming schema `_..sql` and can be found [here](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/tree/migrations) in subdirectories for the specific database. _Note frontend is the pgsql database_. -1. **Find the up migration starting with the migration's version number identified in [step 1](#1-identify-incomplete-migration):** [https://github.com/sourcegraph/sourcegraph/tree/\/migrations](https://github.com/sourcegraph/sourcegraph/tree/main/migrations), making sure to go to \ +1. **Find the up migration starting with the migration's version number identified in [step 1](#1-identify-incomplete-migration):** making sure to go to \ 2. **Run the code from the identified migration _up_ file explicitly using the `psql` CLI:** * It’s possible that one or more commands from the migration ran successfully already. In these cases you may need to run the sql transaction in pieces. For example if a migration file creates multiple indexes and one index already exists you'll need to manually run this transaction skipping that line or adding `IF NOT EXISTS` to the transaction. @@ -96,4 +96,3 @@ Additionally Grafana will alert you of an index is in this state. _The Grafana a ## Further resources * [Sourcegraph - Upgrading Sourcegraph to a new version](/admin/updates) -* [Migrations README](https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/migrations/README) (Note some of the info contained here pertains to running Sourcegraphs development environment and should not be used on production instances) diff --git a/docs/admin/migration/3_30.mdx b/docs/admin/migration/3_30.mdx index c76726680..3d44f3a02 100644 --- a/docs/admin/migration/3_30.mdx +++ b/docs/admin/migration/3_30.mdx @@ -15,6 +15,6 @@ The 3.30 release introduced a `pgsql` and `codeinteldb` base image change from d This caused corruption in indexes that have collatable key columns (e.g. any index with a `text` column). Read more about this [here](https://postgresql.verite.pro/blog/2018/08/27/glibc-upgrade.html). -After we found the root-cause of the [issues many customers were seeing](https://github.com/sourcegraph/sourcegraph/issues/23288), we cut [a patch release, 3.30.3](/technical-changelog#3-30-3), that reverted the images to be based on debian, buying us time to change the alpine based version of the images to [reindex affected indexes on startup, before accepting new connections](https://github.com/sourcegraph/sourcegraph/issues/23310). +After we found the root-cause of the issues many customers were seeing, we cut [a patch release, 3.30.3](/technical-changelog#3-30-3), that reverted the images to be based on debian, buying us time to change the alpine based version of the images to reindex affected indexes on startup, before accepting new connections. However, this means that after fixing the corrupt indexes on the alpine images in the affected releases, upgrading to debian based images in 3.30.3 will cause index corruption again. For this reason, **do not upgrade to 3.30.3** after fixing corrupt Postgres indexes. Instead, [please upgrade directly to 3.31](/admin/migration/3_31). diff --git a/docs/admin/migration/opengrok.mdx b/docs/admin/migration/opengrok.mdx index 3901e9e62..d15b549ac 100644 --- a/docs/admin/migration/opengrok.mdx +++ b/docs/admin/migration/opengrok.mdx @@ -95,8 +95,6 @@ After you've set Sourcegraph up, it's time to share it with your organization. S > - Code browsing: [URL to a code file page on your Sourcegraph instance] > > [Include screenshots of your Sourcegraph instance here] - > - > Post feedback at https://github.com/sourcegraph/sourcegraph [change if needed] - Create an internal document based on the [Sourcegraph tour](/getting-started/tour), substituting links to and names of your organization's code. This explains how Sourcegraph helps developers perform common tasks better. - Encourage installation of the [browser extension](/integration/browser_extension) to get Sourcegraph code navigation and search in your organization's existing code host. @@ -106,4 +104,4 @@ After you've set Sourcegraph up, it's time to share it with your organization. S If there are any blockers preventing your organization from switching to Sourcegraph, we'd love to hear from you so we can address them. -Let us know how we can help! [File an issue](https://github.com/sourcegraph/sourcegraph) with feedback/problems/questions, or [contact us directly](https://about.sourcegraph.com/contact). +Let us know how we can help! [Contact us directly](https://sourcegraph.com/contact). diff --git a/docs/admin/observability/alerts.mdx b/docs/admin/observability/alerts.mdx index c318e15c9..0426c8eff 100644 --- a/docs/admin/observability/alerts.mdx +++ b/docs/admin/observability/alerts.mdx @@ -399,7 +399,7 @@ Generated query for warning alert: `max((sum by (status) (increase(src_graphql_s **Next steps** -- This indicates a bug in Sourcegraph, please [open an issue](https://github.com/sourcegraph/sourcegraph/issues/new/choose). +- This indicates a bug in Sourcegraph, please [contact us](https://sourcegraph.com/contact). - Learn more about the related dashboard panel in the [dashboards reference](dashboards#frontend-search-codeintel-alert-user-suggestions). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -6613,7 +6613,7 @@ Generated query for critical alert: `min((sum by (app) (up{app=~".*indexed-searc - Check the Container monitoring (not available on server) panels and try increasing resources for Prometheus if necessary. - If the rule group taking a long time to evaluate belongs to `/sg_prometheus_addons`, try reducing the complexity of any custom Prometheus rules provided. -- If the rule group taking a long time to evaluate belongs to `/sg_config_prometheus`, please [open an issue](https://github.com/sourcegraph/sourcegraph/issues/new?assignees=&labels=&template=bug_report.md&title=). +- If the rule group taking a long time to evaluate belongs to `/sg_config_prometheus`, please [contact us](https://help.sourcegraph.com/hc/en-us/requests/new). - More help interpreting this metric is available in the [dashboards reference](dashboards#prometheus-prometheus-rule-eval-duration). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: @@ -6646,7 +6646,7 @@ Generated query for warning alert: `max((sum by (rule_group) (avg_over_time(prom - Check Prometheus logs for messages related to rule group evaluation (generally with log field `component="rule manager"`). - If the rule group failing to evaluate belongs to `/sg_prometheus_addons`, ensure any custom Prometheus configuration provided is valid. -- If the rule group taking a long time to evaluate belongs to `/sg_config_prometheus`, please [open an issue](https://github.com/sourcegraph/sourcegraph/issues/new?assignees=&labels=&template=bug_report.md&title=). +- If the rule group taking a long time to evaluate belongs to `/sg_config_prometheus`, please [contact us](https://help.sourcegraph.com/hc/en-us/requests/new). - More help interpreting this metric is available in the [dashboards reference](dashboards#prometheus-prometheus-rule-eval-failures). - **Silence this alert:** If you are aware of this alert and want to silence notifications for it, add the following to your site configuration and set a reminder to re-evaluate the alert: diff --git a/docs/admin/observability/metrics.mdx b/docs/admin/observability/metrics.mdx index 38b893468..699b5ce99 100644 --- a/docs/admin/observability/metrics.mdx +++ b/docs/admin/observability/metrics.mdx @@ -53,7 +53,6 @@ Changes to files in that directory will be detected automatically while Grafana More behavior can be controlled with [environmental variables](https://grafana.com/docs/grafana/latest/administration/configuration/#configure-with-environment-variables). -> NOTE: There is a [known issue](https://github.com/sourcegraph/sourcegraph/issues/6075) where attempting to edit anything using the Grafana UI will result in a 403 response with "invalid CSRF token". > As a workaround, site admins can [connect to Grafana directly](#accessing-grafana-directly) to make changes using the Grafana UI. ### Accessing Grafana directly diff --git a/docs/admin/observability/troubleshooting.mdx b/docs/admin/observability/troubleshooting.mdx index 79c96225f..d21bc7f4d 100644 --- a/docs/admin/observability/troubleshooting.mdx +++ b/docs/admin/observability/troubleshooting.mdx @@ -9,8 +9,7 @@ issue or generating a high-quality issue report. any do, follow the instructions in the subsection. 1. Scan through [General scenarios](#general-scenarios) to find which scenario(s) applies to you. If any do, follow the instructions to update your instance or collect information for the issue report. -1. If you cannot resolve the issue on your own, file an issue on the [Sourcegraph issue - tracker](https://github.com/sourcegraph/sourcegraph/issues) with the collected +2. If you cannot resolve the issue on your own, [contact us](https://help.sourcegraph.com/hc/en-us/requests/new) with the collected information. Enterprise customers may alternatively file a support ticket or email `support@sourcegraph.com`. diff --git a/docs/admin/permissions/index.mdx b/docs/admin/permissions/index.mdx index 647f18cd5..946f9a698 100644 --- a/docs/admin/permissions/index.mdx +++ b/docs/admin/permissions/index.mdx @@ -74,9 +74,6 @@ Support for repository permissions accross different code hosts is different. Th All the other code hosts only support [Explicit permissions API](/admin/permissions/api). - -> NOTE: If your desired code host is not yet supported, please [open a feature request](https://github.com/sourcegraph/sourcegraph/issues/new?template=feature_request). - ### Supported scale If not otherwise stated in the table above, all code hosts should support up to 10k users and 100k repositories for permission syncing. diff --git a/docs/admin/pings.mdx b/docs/admin/pings.mdx index 50d0391d5..677d63fb1 100644 --- a/docs/admin/pings.mdx +++ b/docs/admin/pings.mdx @@ -265,7 +265,7 @@ The most common scenario in which Sourcegraph stops sending pings is a change to ### Check if the goroutine is running -*This section is under development and currently only applies for docker-compose instances: [39710](https://github.com/sourcegraph/sourcegraph/issues/39710)* +*This section is under development and currently only applies for docker-compose instances.* If it's reported that pings aren't being sent to the Sourcegraph.com, you can check that the goroutine is running with the following command: ``` diff --git a/docs/admin/repo/perforce.mdx b/docs/admin/repo/perforce.mdx index db9d4d824..10072c96a 100644 --- a/docs/admin/repo/perforce.mdx +++ b/docs/admin/repo/perforce.mdx @@ -268,14 +268,13 @@ With this setting, Sourcegraph will ignore any rules with a host other than `*`, ## Known issues and limitations -We are actively working to significantly improve Sourcegraph's Perforce support. Please [file an issue](https://github.com/sourcegraph/sourcegraph/issues) to help us prioritize any specific improvements you'd like to see. +We are actively working to significantly improve Sourcegraph's Perforce support. Please [contact us](https://help.sourcegraph.com/hc/en-us/requests/new) to help us prioritize any specific improvements you'd like to see. - Sourcegraph was initially built for Git repositories only, so it stores Perforce depots as Git repositories when syncing. Perforce concepts and languages are expressed in the UI, but under the hood, Git tools are used. - Batch Changes does not support [file-level permissions](#file-level-permissions) (also known as sub-repo permissions) - Batch Changes does not handle the shelved changelist other than to query the Perforce server for its status. - Permalinks with Changelist Id do not work yet - ## Configure experimental features As of Sourcegraph 5.1, there are the following experimental features for Perforce depots. These are merely for providing feedback and have [limited support](/admin/beta_and_experimental_features#experimental-features). @@ -308,7 +307,7 @@ As of Sourcegraph 5.5, you can search within a specific changelist by referring repo:^Talkhouse/main$@changelist/123 text to find ``` -or +or ``` repo:^Talkhouse/main$ rev:changelist/123 text to find ``` diff --git a/docs/admin/troubleshooting.mdx b/docs/admin/troubleshooting.mdx index 196c0cf26..a481c827a 100644 --- a/docs/admin/troubleshooting.mdx +++ b/docs/admin/troubleshooting.mdx @@ -19,8 +19,6 @@ This problem is caused by [docker/toolbox#695](https://github.com/docker/toolbox docker container run -e LOGO=false ... sourcegraph/server ``` -See [sourcegraph/sourcegraph#398](https://github.com/sourcegraph/sourcegraph/issues/398) for more information. - > WARNING: Running Sourcegraph on Docker Toolbox for Windows is not supported for production deployments. ### Submitting a metrics dump diff --git a/docs/admin/updates/docker_compose.mdx b/docs/admin/updates/docker_compose.mdx index b03309477..ce5282bff 100644 --- a/docs/admin/updates/docker_compose.mdx +++ b/docs/admin/updates/docker_compose.mdx @@ -28,7 +28,7 @@ For upgrade procedures or general info about sourcegraph versioning see the link > Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! #### Notes: -- The container image for pgsql and codeintel-db have been renamed from `postgres-12-alpine` and `codeintel-db` respectively to `postgresql-16`. The `codeinsights-db` container has been renamed to `postgresql-16-codeinsights`. +- The container image for pgsql and codeintel-db have been renamed from `postgres-12-alpine` and `codeintel-db` respectively to `postgresql-16`. The `codeinsights-db` container has been renamed to `postgresql-16-codeinsights`. - **Admins using external dbs who have not yet upgraded from postgres 12 to postgres 16**, can expect to see database drift after upgrading to `5.10.0`. The new expected schema definition for Sourcegraph is based on postgres 16. The schema drift is the result of automatic changes made to the schema by pg_upgrade utils, and will not cause issues in the application. - Admins should not run migrators suggested drift fixes, and should instead upgrade their database from postgres 12 to postgres 16. - The [Autoupgrade](https://sourcegraph.com/docs/admin/updates/automatic#pre-v500-automatic-multiversion-upgrades) upgrade method, will detect drift and exit before conducting the upgrade unless the env var `SRC_AUTOUPGRADE_IGNORE_DRIFT=true` is set in the server container. @@ -37,27 +37,26 @@ For upgrade procedures or general info about sourcegraph versioning see the link ## v5.1.4 βž” v5.1.5 #### Notes: -- Upgrades from versions `v5.0.3`, `v5.0.4`, `v5.0.5`, and `v5.0.6` to `v5.1.5` are affected by an ordering error in the `frontend` databases migration tree. Learn more from the [PR which resolves this bug](https://github.com/sourcegraph/sourcegraph/pull/55650). **For admins who have already attempted an upgrade to this release from one of the effected versions, see this issue which provides a description of [how to manually fix the frontend db](https://github.com/sourcegraph/sourcegraph/issues/55658).** +- Upgrades from versions `v5.0.3`, `v5.0.4`, `v5.0.5`, and `v5.0.6` to `v5.1.5` are affected by an ordering error in the `frontend` databases migration tree. ## v5.1.3 βž” v5.1.4 #### Notes: -- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. See [this issue](https://github.com/sourcegraph/sourcegraph/issues/55048) for more details. - +- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. ## v5.1.2 βž” v5.1.3 #### Notes: -- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. See [this issue](https://github.com/sourcegraph/sourcegraph/issues/55048) for more details. +- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. ## v5.1.1 βž” v5.1.2 #### Notes: -- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. See [this issue](https://github.com/sourcegraph/sourcegraph/issues/55048) for more details. +- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. ## v5.1.0 βž” v5.1.1 #### Notes: -- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. See [this issue](https://github.com/sourcegraph/sourcegraph/issues/55048) for more details. +- Migrator images were built without the `v5.1.x` tag in this version, as such multiversion upgrades using this image version will fail to upgrade to versions in `v5.1.x`. ## v5.0.6 βž” v5.1.0 @@ -89,7 +88,7 @@ This release introduces a background job that will convert all LSIF data into SC #### Notes: -- Users attempting a multi-version upgrade to v4.4.0 may be affected by a [known bug](https://github.com/sourcegraph/sourcegraph/pull/46969) in which an outdated schema migration is included in the upgrade process. _This issue is fixed in patch v4.4.2_ +- Users attempting a multi-version upgrade to v4.4.0 may be affected by a bug in which an outdated schema migration is included in the upgrade process. _This issue is fixed in patch v4.4.2_ - The error will be encountered while running `upgrade`, and contains the following text: `"frontend": failed to apply migration 1648115472`. - To resolve this issue run migrator with the args `'add-log', '-db=frontend', '-version=1648115472'`. - If migrator was stopped while running `upgrade` the next run of upgrade will encounter drift, this drift should be disregarded by providing migrator with the `--skip-drift-check` flag. diff --git a/docs/admin/updates/index.mdx b/docs/admin/updates/index.mdx index eee05cf2c..02a653a5d 100644 --- a/docs/admin/updates/index.mdx +++ b/docs/admin/updates/index.mdx @@ -17,7 +17,7 @@ This page is intended as an entry point into Sourcegraph versioning, upgrades, a ### Upgrading -A new Sourcegraph release consists of updated images that incorporate code changes from our [main repository](https://github.com/sourcegraph/sourcegraph). It also includes modifications to deployment manifests in our supporting deployment repositories, such as our [k8s helm repo](https://github.com/sourcegraph/deploy-sourcegraph-helm). +A new Sourcegraph release consists of updated images that incorporate code changes. It also includes modifications to deployment manifests in our supporting deployment repositories, such as our [k8s helm repo](https://github.com/sourcegraph/deploy-sourcegraph-helm). When upgrading Sourcegraph, it is necessary to update and apply the deployment manifests. However, in addition to the manifest updates, it is crucial to ensure that all underlying database schemas of Sourcegraph are also updated. diff --git a/docs/admin/updates/kubernetes.mdx b/docs/admin/updates/kubernetes.mdx index 4a33ec6ba..a653af99e 100644 --- a/docs/admin/updates/kubernetes.mdx +++ b/docs/admin/updates/kubernetes.mdx @@ -30,7 +30,7 @@ For upgrade procedures or general info about sourcegraph versioning see the link > Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! #### Notes: -- The container image for pgsql and codeintel-db have been renamed from `postgres-12-alpine` and `codeintel-db` respectively to `postgresql-16`. The `codeinsights-db` container has been renamed to `postgresql-16-codeinsights`. +- The container image for pgsql and codeintel-db have been renamed from `postgres-12-alpine` and `codeintel-db` respectively to `postgresql-16`. The `codeinsights-db` container has been renamed to `postgresql-16-codeinsights`. - **Admins using external dbs who have not yet upgraded from postgres 12 to postgres 16**, can expect to see database drift after upgrading to `5.10.0`. The new expected schema definition for Sourcegraph is based on postgres 16. The schema drift is the result of automatic changes made to the schema by pg_upgrade utils, and will not cause issues in the application. - Admins should not run migrators suggested drift fixes, and should instead upgrade their database from postgres 12 to postgres 16. - Postgres 12 image containers cannot be started with data volumes which have been upgraded by postgres 16. @@ -40,7 +40,7 @@ For upgrade procedures or general info about sourcegraph versioning see the link #### Notes: -- The GitHub proxy service has been removed and is no longer required. You can safely remove it. [#55290](https://github.com/sourcegraph/sourcegraph/issues/55290) +- The GitHub proxy service has been removed and is no longer required. You can safely remove it. ## v5.1.6 βž” v5.1.7 @@ -52,7 +52,7 @@ For upgrade procedures or general info about sourcegraph versioning see the link #### Notes: -- Upgrades from versions `v5.0.3`, `v5.0.4`, `v5.0.5`, and `v5.0.6` to `v5.1.5` are affected by an ordering error in the `frontend` databases migration tree. Learn more from the [PR which resolves this bug](https://github.com/sourcegraph/sourcegraph/pull/55650) in `v5.1.6`. **For admins who have already attempted an upgrade to this release from one of the effected versions, see this issue which provides a description of [how to manually fix the frontend db](https://github.com/sourcegraph/sourcegraph/issues/55658).** +- Upgrades from versions `v5.0.3`, `v5.0.4`, `v5.0.5`, and `v5.0.6` to `v5.1.5` are affected by an ordering error in the `frontend` databases migration tree. ## v4.4.2 βž” v4.5.0 @@ -74,7 +74,7 @@ For upgrade procedures or general info about sourcegraph versioning see the link #### Notes: -- Users attempting a multi-version upgrade to v4.4.0 may be affected by a [known bug](https://github.com/sourcegraph/sourcegraph/pull/46969) in which an outdated schema migration is included in the upgrade process. _This issue is fixed in patch v4.4.2_ +- Users attempting a multi-version upgrade to v4.4.0 may be affected by a bug in which an outdated schema migration is included in the upgrade process. _This issue is fixed in patch v4.4.2_ - The error will be encountered while running `upgrade`, and contains the following text: `"frontend": failed to apply migration 1648115472`. - To resolve this issue run migrator with the args `'add-log', '-db=frontend', '-version=1648115472'`. diff --git a/docs/admin/updates/migrator/schema-drift.mdx b/docs/admin/updates/migrator/schema-drift.mdx index c5302feb1..943d12e74 100644 --- a/docs/admin/updates/migrator/schema-drift.mdx +++ b/docs/admin/updates/migrator/schema-drift.mdx @@ -85,4 +85,4 @@ RETURN NULL; END $function$; ``` -If migrator drift suggests SQL queries which don't make sense please report to support@sourcegraph.com or open an issue in the [`sourcegraph/sourcegraph`](https://github.com/sourcegraph/sourcegraph/issues/new?assignees=&labels=&template=bug_report&title=) repo. You may proceed with a migrator `upgrade` command using the `-skip-drift-check=true` flag. +If migrator drift suggests SQL queries which don't make sense please report to support@sourcegraph.com. You may proceed with a migrator `upgrade` command using the `-skip-drift-check=true` flag. diff --git a/docs/admin/updates/pure_docker.mdx b/docs/admin/updates/pure_docker.mdx index 2344c7def..4875f1fd2 100644 --- a/docs/admin/updates/pure_docker.mdx +++ b/docs/admin/updates/pure_docker.mdx @@ -270,7 +270,7 @@ As a template, perform the same actions as the following diffs in your own deplo As a template, perform the same actions as the following diffs in your own deployment: - [`βž” v4.4.0`](https://github.com/sourcegraph/deploy-sourcegraph-docker/commit/8cdeb7616b73e100aec41806b1118264fea0615d) -- Users attempting a multi-version upgrade to v4.4.0 may be affected by a [known bug](https://github.com/sourcegraph/sourcegraph/pull/46969) in which an outdated schema migration is included in the upgrade process. _This issue is fixed in patch v4.4.2_ +- Users attempting a multi-version upgrade to v4.4.0 may be affected by a bug in which an outdated schema migration is included in the upgrade process. _This issue is fixed in patch v4.4.2_ - The error will be encountered while running `upgrade`, and contains the following text: `"frontend": failed to apply migration 1648115472`. - To resolve this issue run migrator with the args `'add-log', '-db=frontend', '-version=1648115472'`. diff --git a/docs/admin/updates/server.mdx b/docs/admin/updates/server.mdx index 08cbfff34..7604f75fb 100644 --- a/docs/admin/updates/server.mdx +++ b/docs/admin/updates/server.mdx @@ -29,10 +29,10 @@ For upgrade procedures or general info about sourcegraph versioning see the link > Warning: `automatic` and migrator `upgrade` command will not work for this release, please upgrade directly to `v5.10.1164`, or to a 5.9 version and conduct a standard upgrade using migrator's default `up` command! **What does this mean for admins?** -- During the postgres version upgrade `pg_upgrade` automatically makes some changes to the database schema. +- During the postgres version upgrade `pg_upgrade` automatically makes some changes to the database schema. - The new canonical database schema is now based on postgres 16, the drift detection tool will report drift between the old and new database schema. This is expected and is a result of the postgres upgrade. - Admins should not run migrators suggested drift fixes until the database is upgraded. - + ## v5.0.6 βž” v5.1.0 @@ -86,10 +86,9 @@ For upgrade procedures or general info about sourcegraph versioning see the link No upgrade notes. ## v3.20 βž” v3.21 -> WARNING: **This upgrade must originate from `v3.17.2`** due to a [patched](https://github.com/sourcegraph/sourcegraph/pull/11633) [bug](https://github.com/sourcegraph/sourcegraph/issues/11618) in our release. +> WARNING: **This upgrade must originate from `v3.17.2`** due to a patched bug in our release. #### Notes: - This release introduces a second database instance, `codeintel-db`. If you have configured Sourcegraph with an external database, then update the `CODEINTEL_PG*` environment variables to point to a new external database as described in the [external database documentation](/admin/external_services/postgres). Again, these must not point to the same database or the Sourcegraph instance will refuse to start. - **Turn off database secrets encryption**. In Sourcegraph version 3.20, we would automatically generate a secret key file (`/var/lib/sourcegraph/token`) inside the container for encrypting secrets stored in the database. However, it is not yet ready for general use and format of the secret key file might change. Therefore, it is best to delete the secret key file (`/var/lib/sourcegraph/token`) and turn off the database secrets encryption. - diff --git a/docs/code-search/code-navigation/how-to/adding_scip_to_workflows.mdx b/docs/code-search/code-navigation/how-to/adding_scip_to_workflows.mdx index 74551c275..420b21c6a 100644 --- a/docs/code-search/code-navigation/how-to/adding_scip_to_workflows.mdx +++ b/docs/code-search/code-navigation/how-to/adding_scip_to_workflows.mdx @@ -6,7 +6,7 @@ We are working on creating language specific guides for use with different index ## Benefits of CI integration -Setting up a source code indexing job in your CI build provides you with fast code navigation that gives you more control on when source code gets indexed, and ensures accuracy of your code navigation by keeping in sync with changes in your repository. Due to the large number of CI frameworks and languages we may not have specific documentation for your use case. Feel free to [file an issue](https://github.com/sourcegraph/sourcegraph/issues/new) if you're having difficulties and we can help troubleshoot your setup. +Setting up a source code indexing job in your CI build provides you with fast code navigation that gives you more control on when source code gets indexed, and ensures accuracy of your code navigation by keeping in sync with changes in your repository. Due to the large number of CI frameworks and languages we may not have specific documentation for your use case. Feel free to [contact us](https://help.sourcegraph.com/hc/en-us/requests/new) if you're having difficulties and we can help troubleshoot your setup. ## Using indexer containers @@ -175,7 +175,7 @@ The following projects have example Travis CI configurations to generate and upl ## CI from scratch -If you're indexing a language we haven't documented yet in our [language-specific guides](/code-search/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase), follow the instructions in this section. We want to have containers available for every language with a robust indexer, so please also consider [filing an issue](https://github.com/sourcegraph/sourcegraph/issues/new) to let us know we're missing one. +If you're indexing a language we haven't documented yet in our [language-specific guides](/code-search/code-navigation/precise_code_navigation#setting-up-code-navigation-for-your-codebase), follow the instructions in this section. We want to have containers available for every language with a robust indexer, so please [contact](https://help.sourcegraph.com/hc/en-us/requests/new) to let us know we're missing one. ### Set up your CI machines diff --git a/docs/code-search/code-navigation/how-to/index_other_languages.mdx b/docs/code-search/code-navigation/how-to/index_other_languages.mdx index 0a0141886..2e5120038 100644 --- a/docs/code-search/code-navigation/how-to/index_other_languages.mdx +++ b/docs/code-search/code-navigation/how-to/index_other_languages.mdx @@ -61,7 +61,7 @@ Once LSIF data has uploaded, open the Sourcegraph UI or your code host (i.e. Git ### Error Logs -To view code graph indexer processing failures go to **Repository settings > Code graph data > Activity for this repository** in your Sourcegraph instance. Failures can occur if the LSIF data is invalid (e.g., malformed indexer output), or problems were encountered during processing (e.g., system-level bug, flaky connections, etc). Try again or [file an issue](https://github.com/sourcegraph/sourcegraph/issues/new) if the problem persists. +To view code graph indexer processing failures go to **Repository settings > Code graph data > Activity for this repository** in your Sourcegraph instance. Failures can occur if the LSIF data is invalid (e.g., malformed indexer output), or problems were encountered during processing (e.g., system-level bug, flaky connections, etc). If you are unable to resolve the issue, please [contact support](https://help.sourcegraph.com/hc/en-us/requests/new). ### Common Errors diff --git a/docs/code-search/code-navigation/search_based_code_navigation.mdx b/docs/code-search/code-navigation/search_based_code_navigation.mdx index e4ffafe58..1916a46c4 100644 --- a/docs/code-search/code-navigation/search_based_code_navigation.mdx +++ b/docs/code-search/code-navigation/search_based_code_navigation.mdx @@ -13,7 +13,7 @@ Sourcegraph comes with a default built-in code navigation provided by search-bas ## How does it work? -[Search-based Code Navigation](https://github.com/sourcegraph/sourcegraph-basic-code-intel) provides 3-core navigation features: +Search-based Code Navigation provides 3-core navigation features: - **Jump to definition**: Performs a [symbol search](/code-search/features#symbol-search). - **Hover documentation**: First, finds the definition. Then, extracts documentation from comments near the definition. diff --git a/docs/code_insights/explanations/administration_and_security_of_code_insights.mdx b/docs/code_insights/explanations/administration_and_security_of_code_insights.mdx index 6986618a0..f61298172 100644 --- a/docs/code_insights/explanations/administration_and_security_of_code_insights.mdx +++ b/docs/code_insights/explanations/administration_and_security_of_code_insights.mdx @@ -77,7 +77,7 @@ the timeout for each language stats query from 3 minutes to 5 minutes. ### Concurrent Requests -This concurrent requests to the gitserver are configurable through the `GET_INVENTORY_GIT_SERVER_CONCURRENCY` environment variable ([#62011](https://github.com/sourcegraph/sourcegraph/pull/62011)). +This concurrent requests to the gitserver are configurable through the `GET_INVENTORY_GIT_SERVER_CONCURRENCY` environment variable. We recommend increasing this carefully, as an increase in concurrency may cause the gitserver to become overloaded and slow down responses. Example: @@ -90,7 +90,7 @@ To understand how this configuration impacts your language stats queries you can ### Language Stats Timeout -The timeout in minutes for language stats queries is configurable through the `GET_INVENTORY_TIMEOUT` environment variable ([#62011](https://github.com/sourcegraph/sourcegraph/pull/62011)). +The timeout in minutes for language stats queries is configurable through the `GET_INVENTORY_TIMEOUT` environment variable. Example: diff --git a/docs/code_insights/explanations/current_limitations_of_code_insights.mdx b/docs/code_insights/explanations/current_limitations_of_code_insights.mdx index 219d40bb4..a9e00c79a 100644 --- a/docs/code_insights/explanations/current_limitations_of_code_insights.mdx +++ b/docs/code_insights/explanations/current_limitations_of_code_insights.mdx @@ -49,7 +49,7 @@ If this does not solve your problem, please reach out directly to your Sourcegra ## Accuracy considerations for an insight query returning a large result set -If you create an insight with a search query that returns a large result set that exceeds the search timeout (generally when there are over 1,000,000 results), non-historical data points may report undercounted numbers. This behaviour is tracked in [this issue](https://github.com/sourcegraph/sourcegraph/issues/37859). This is because non-historical data points are recorded with a global search query as opposed to per-repo queries we run for backfilling. For a large result set (e.g. a query for `test` with millions of results) the global query will be disadvantaged by the global search timeout. You can find more information on search timeouts in the [docs](/code-search/queries/language#timeout). +If you create an insight with a search query that returns a large result set that exceeds the search timeout (generally when there are over 1,000,000 results), non-historical data points may report undercounted numbers. This is because non-historical data points are recorded with a global search query as opposed to per-repo queries we run for backfilling. For a large result set (e.g. a query for `test` with millions of results) the global query will be disadvantaged by the global search timeout. You can find more information on search timeouts in the [docs](/code-search/queries/language#timeout). You can determine if this issue may be affecting your query by just running the query in the Search UI on `/search` with a `count:all` – if your search is returning `x results in 60s` (or the upper limit max timeout is configured to) then the search will time out on insights as well. Note that the duration could be more or less `60s`, e.g. you could encounter `60.02s` as well. @@ -108,10 +108,6 @@ Please see [Current limitations of automatically generated data series](/code_in There are currently a few subtle differences in how code insights and Sourcegraph web app searches handle defaults when searching over all repositories. Refer to [Common reasons code insights may not match search results](/code_insights/references/common_reasons_code_insights_may_not_match_search_results). -## Known bugs - -Known bugs we plan to fix are tracked in our [GitHub repository here](https://github.com/sourcegraph/sourcegraph/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Ateam%2Fcode-insights). - ## Older versions' limitations ### Version 3.30 (July 2021) or older diff --git a/docs/code_insights/references/common_reasons_code_insights_may_not_match_search_results.mdx b/docs/code_insights/references/common_reasons_code_insights_may_not_match_search_results.mdx index 7996f0c19..76cb28ea9 100644 --- a/docs/code_insights/references/common_reasons_code_insights_may_not_match_search_results.mdx +++ b/docs/code_insights/references/common_reasons_code_insights_may_not_match_search_results.mdx @@ -22,8 +22,6 @@ To investigate this, one can compare the list of repositories in the manual sear Currently, a data series' most recent datapoint defaults to the end of the prior month. It's possible that in the time between when your insight ran and when you ran a manual search, new matches have been added to your codebase. To confirm this, you can run `type:diff` or `type:commit` searches using the `after:` filter, but note that those filters only support up to 10,000 repositories, so you may first need to limit your search repository set. -> NOTE: Future releases of Code Insights may include [an always-up-to-date present-time point](https://github.com/sourcegraph/sourcegraph/issues/24186). - ### Repository timeouts caused a datapoint to miss results If your code insight is very large, it is possible that a few (\<1% in 100+ manual tests over 26,000 repositories) repositories failed to return match counts due to timing out while searching. To check this, you can run the following GraphQL query in the Sourcegraph GraphQL API: diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 17d82d560..0f5cbb0fb 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -57,11 +57,6 @@ You can also try [Sourcegraph.com](https://sourcegraph.com/search), a public Sou Sourcegraph Enterprise is Sourcegraph's primary offering and includes all code intelligence platform features. Sourcegraph Enterprise is the best solution for enterprises who want to use Sourcegraph with their organization's code. -Sourcegraph extensions are also OSS licensed (Apache 2), such as: - -- [Sourcegraph browser extension](https://github.com/sourcegraph/sourcegraph/tree/master/client/browser) -- [Sourcegraph Jetbrains extension](https://github.com/sourcegraph/sourcegraph/tree/main/client/jetbrains) - ## How is Sourcegraph different from the GitHub code search? - [See how GitHub code search compares to Sourcegraph](/getting-started/github-vs-sourcegraph) diff --git a/docs/getting-started/personalization/badges.mdx b/docs/getting-started/personalization/badges.mdx index d74a20a61..b1e2ecd2d 100644 --- a/docs/getting-started/personalization/badges.mdx +++ b/docs/getting-started/personalization/badges.mdx @@ -18,7 +18,7 @@ This renders the following badge: ## Known issues -Please report any other issues and feature requests on the [Sourcegraph issue tracker](https://github.com/sourcegraph/sourcegraph/issues). +Please report any other issues and feature requests [here](https://help.sourcegraph.com/hc/en-us/requests/new). - The number may be overcounted because it is the sum of counts for all of the repository's subpackages. If another project uses multiple subpackages in this repository, the project is counted multiple times. - Importers using custom Go import paths (i.e., anything other than import paths prefixed by the repository name, such as `github.com/foo/bar`) will not be counted. diff --git a/docs/integration/browser_extension/how-tos/troubleshooting.mdx b/docs/integration/browser_extension/how-tos/troubleshooting.mdx index bd4c75c2d..15811e7fd 100644 --- a/docs/integration/browser_extension/how-tos/troubleshooting.mdx +++ b/docs/integration/browser_extension/how-tos/troubleshooting.mdx @@ -40,7 +40,7 @@ In Safari: 2. In Develop select Web Extension Background Pages > Sourcegraph 3. Select the Network tab -If that still doesn't help, take a screenshot of the console and network activity and attach it [to a new issue](https://github.com/sourcegraph/sourcegraph/issues/new?assignees=&labels=&template=bug_report&title=Browser%20extension%20-%20) so we can investigate further. +If that still doesn't help, take a screenshot of the console and network activity and [report here](https://help.sourcegraph.com/hc/en-us/requests/new) so we can investigate further. ## Unable to connect to `http://...` Ensure the URL is correct and you are logged in diff --git a/docs/integration/go.mdx b/docs/integration/go.mdx index ddc347fb4..1d54674fe 100644 --- a/docs/integration/go.mdx +++ b/docs/integration/go.mdx @@ -25,5 +25,3 @@ Site admins can [add Go packages to Sourcegraph](/admin/code_hosts/go#repository ## Multiple Go dependencies code hosts ⚠️ It's only possible to create one Ruby dependency code host for each Sourcegraph instance. - -See the issue [sourcegraph#32461](https://github.com/sourcegraph/sourcegraph/issues/32461) for more details about this limitation.