Skip to content

Commit e11da5e

Browse files
authored
Merge branch 'main' into anorrish-arch-doc-updates
2 parents e82a289 + 521bb22 commit e11da5e

File tree

82 files changed

+13002
-12855
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+13002
-12855
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Sourcegraph Docs
22

3-
<!-- Working branch for April 2025 Release -->
3+
<!-- Working branch for SG 6.3 Release -->
44

55
Welcome to the Sourcegraph documentation! We're excited to have you contribute to our docs. We've recently rearchitectured our docs tech stack — powered by Next.js, TailwindCSS and deployed on Vercel. This guide will walk you through the process of contributing to our documentation using the new tech stack.
66

docs.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const config = {
2-
DOCS_LATEST_VERSION: '6.2'
2+
DOCS_LATEST_VERSION: '6.3'
33
};
44

55
module.exports = config;

docs/admin/auth/index.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@ order:
5656
use the [OpenID Connect provider](#openid-connect).
5757
- If you wish to use LDAP and cannot use the GitHub/GitLab OAuth provider as described above, or if
5858
you wish to use another authentication mechanism that is not yet supported, please [contact
59-
us](https://github.com/sourcegraph/sourcegraph/issues/new?template=feature_request) (we respond
60-
promptly).
59+
us](https://sourcegraph.com/contact)
6160

6261
Most users will use only one auth provider, but you can use multiple auth providers if desired to
6362
enable sign-in via multiple services. Identities from different providers will be mapped to a

docs/admin/auth/saml/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Error prefetching SAML service provider metadata
8181

8282
> 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/<user>/settings/emails`, or remove the user and recreate a new account.
8383
>
84-
> Work is planned to support SCIM on SAML auth providers, which should automate this process. ([tracking issue](https://github.com/sourcegraph/sourcegraph/issues/22732))
84+
> Work is planned to support SCIM on SAML auth providers, which should automate this process.
8585
8686
### How to control user sign-up and sign-in
8787

docs/admin/beta_and_experimental_features.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Sourcegraph often beta tests major features before we make them generally availa
44

55
Exposing beta and experimental features gives you an opportunity to try our newest features sooner.
66

7-
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 [[email protected]](mailto:[email protected]), or use the in-app feedback modal.
7+
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 [[email protected]](mailto:[email protected]).
88

99
## Both beta and experimental features
1010

docs/admin/code_hosts/github.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ There are four fields for configuring which repositories are mirrored/synchroniz
241241

242242
- [`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.
243243
- [`orgs`](/admin/code_hosts/github#orgs)A list of organizations (every repository belonging to the organization will be cloned).
244-
- [`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.
244+
- [`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).
245245
- [`exclude`](/admin/code_hosts/github#exclude)A list of repositories to exclude which takes precedence over the `repos`, `orgs`, and `repositoryQuery` fields.
246246

247247
## Rate limits

docs/admin/config/advanced_config_file.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ When you upgrade Sourcegraph, you should do the following to ensure your configu
119119

120120
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.
121121

122-
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.
122+
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.
123123

124124
## Kubernetes ConfigMap
125125

docs/admin/config/batch_changes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ You may encounter this error when publishing changesets to GitHub:
6060
6161
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.
6262

63-
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.
63+
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.
6464

6565
### Rollout window object
6666

docs/admin/deploy/docker-single-container/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ From sourcegraph version 5.11 onwards, the Sourcegraph single container Docker i
164164

165165
`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}`
166166

167-
You now have a single server Sourcegraph container image running on Postgresql 16.
167+
You now have a single server Sourcegraph container image running on Postgresql 16.
168168

169169

170170
### Standard upgrades
@@ -271,7 +271,7 @@ The version of this Postgres container is dependent on the version of the instan
271271

272272
## Troubleshooting
273273

274-
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).
274+
If you get stuck or need help, please reach out to [Sourcegraph support](https://help.sourcegraph.com/hc/en-us/requests/new).
275275

276276
### Mac Computers with Apple silicon
277277

docs/admin/deploy/kubernetes/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1107,7 +1107,7 @@ Some Persistent Volumes may be retained after the uninstall phase is complete. I
11071107
[AWS EBS CSI driver]: https://docs.aws.amazon.com/eks/latest/userguide/managing-ebs-csi.html
11081108
[NGINX Ingress Controller]: https://github.com/kubernetes/ingress-nginx
11091109
[Helm Changelog]: https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph/CHANGELOG
1110-
[Sourcegraph Changelog]: https://github.com/sourcegraph/sourcegraph-public-snapshot/blob/main/CHANGELOG
1110+
[Sourcegraph Changelog]: https://sourcegraph.com/changelog
11111111
[Sourcegraph Migrator]: https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph-migrator
11121112
[Helm Diff]: https://github.com/databus23/helm-diff
11131113
[Secrets]: https://kubernetes.io/docs/concepts/configuration/secret/

0 commit comments

Comments
 (0)