Skip to content

Conversation

@MaedahBatool
Copy link
Contributor

@MaedahBatool MaedahBatool commented May 28, 2025

Docs for batch changes updates that are going live in version 6.4

evict and others added 30 commits December 13, 2024 16:57
This adds documentation on how to configure the `ExternalClient`'s
denylist. Previously undocumented, but useful for self-hosting
customers.
fixed broken numbering in the top section and rewrote some of the
sentences for better clarity

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
Update broken links pointing to the kustomize deployment in the
technical changelog.

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
Centralizing, deduplicating, and correcting information about HTTP traces, from multiple different pages into two primary pages specifically about Tracing and OpenTelemetry, then minimizing the content on the deployment / config pages to link back to these two, only leaving the deployment-type-specific details on the pages for each deployment-type.

<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
Fixing broken links and spelling

<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
This adds documentation about the new allowlist for "untrusted" external
connections, released in 5.11.

---------

Co-authored-by: Camden Cheek <camden@ccheek.com>
Specifying the details needed for customers to secure their Grafana
container.

<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
Clarifying the different approaches for new vs existing instances.

<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
#865)

<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
This is an automated changelog update for v5.10.3940

---------

Co-authored-by: Warren Gifford <warrenbruceg@gmail.com>
Co-authored-by: Jacob Pleiness <jacob.pleiness@sourcegraph.com>
<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
This is an automated changelog update for v5.11.0
Fix some terminal output that ended up in the changelog somehow. 

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
The original snippet has some issues:
The loop will not handle spaces correctly and may misinterpret the path.
The entire string is treated as one entity due to the quotes, leading to
incorrect processing.

Updated the loop handling in the script to correctly process file paths
by switching from space-delimited to newline-delimited entries. This
ensures the handling of paths with spaces or special characters. Added
IFS=$'\n' for proper splitting and quoting of paths in the loop for
safety.

![Screenshot 2024-12-19 at 3 10
35 PM](https://github.com/user-attachments/assets/4f10c4bb-cba2-4659-862f-4980c2c0b7c1)
Spaces in file names
![Screenshot 2024-12-19 at 3 09
23 PM](https://github.com/user-attachments/assets/771935b7-6d84-4bf7-bc0e-f7fe1b01959c)

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
Replaced the cat-based approach with a direct input redirection method
using `while IFS= read -r`. This change ensures proper handling of the
last line which doesn't have a trailing new line.

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
<!-- Explain the changes introduced in your PR -->
A couple customers are getting confused and using both env vars and cody
auth login to authenticate with the CLI leading to undesirable effects.
This change adds emphasis for customers getting started with CLI

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
The changes introduce support for the OpenAI provider in the Cody VS
Code extension configuration, along with additional configuration
options for input and output token sizes, and provider-specific options.
This provides more flexibility and options for users when configuring
their Cody integration.

<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
Added The maximum number of repo-centric permissions syncing jobs that
can be spawned concurrently in the doc config.
We only conditionally replace this _if_ there is a version number in the
code block, because this breaks syntax highlighting.

This is kind of a cheap hack, and we should really be replacing the
strings with version numbers further upstream before they get broken
into syntax highlighting chunks, that way we get to keep both working
version numbers, as well as syntax highlighting.

I tried messing around with contentlayer to replace these strings
further upstream, but I couldn't figure it out within my timeboxed
session. Hence leaving this PR as it is, because it's fairly important
that correct version numbers be displayed and copied by our customers.

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
This is an automated changelog update for v5.11.2732
Updated the doc for clarity.

---------

Co-authored-by: Alex Jean-Baptiste <alex.jean-baptiste@sourcegraph.com>
link fix

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
Added The maximum number of repo-centric permissions syncing jobs that
can be spawned concurrently in the site config doc .
Add troubleshooting note to Cody troubleshooting about adding forked
repos as context

<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
This is based on internal feedback that the documentation doesn't
describe how to consume the results.

Test plan:
N/A
MaedahBatool and others added 14 commits May 14, 2025 13:48
<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
This is an automated changelog update for v6.3.2692
…1140)

- fixes a couple of 404 broken links on the precise indexing doc page
- remove reference to auto-dependency indexing which relies on [package
code hosts](#724)

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
Removed mention of Cody Pro in agentic chat because it is no longer
available and misleading to users

<!-- Explain the changes introduced in your PR -->

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
INDEXED_SEARCH_INDEXERS was added in a previous release but I missed to
document it properly which caused unexpected log spam for customers
using docker and failed pods for customers on K8S without service
discovery.

---------

Co-authored-by: Marc <7050295+marcleblanc2@users.noreply.github.com>
Documents the new `openaicompatible` model configurations supported as
part of
https://linear.app/sourcegraph/issue/CORE-1019/enablement-ga-self-hosted-models-additional-openai-compatible

---------

Signed-off-by: Emi <emi@sourcegraph.com>
Co-authored-by: Maedah Batool <me@MaedahBatool.com>
See sourcegraph/sourcegraph#5504 for more
details, the previous approach has been deprecated by Microsoft and no
longer works.

Closes SRC-1300.

Test plan: Ran through this process locally and ended up with working
perms syncing.
See
https://sourcegraph.slack.com/archives/C05EMJM2SLR/p1747950678213499?thread_ts=1747950304.392389&cid=C05EMJM2SLR

## Pull Request approval

You will need to get your PR approved by at least one member of the
Sourcegraph team. For reviews of docs formatting, styles, and component
usage, please tag the docs team via the #docs Slack channel.
This is an automated changelog update for v6.3.4167
@vercel
Copy link

vercel bot commented May 28, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sourcegraph-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 28, 2025 6:20am

@MaedahBatool MaedahBatool self-assigned this May 28, 2025
@MaedahBatool MaedahBatool added the documentation Improvements or additions to documentation label May 28, 2025
@MaedahBatool
Copy link
Contributor Author

Hi @derek-feriancek-sg I have merged all BC updates into one PR. Please, can I get your review?

@MaedahBatool MaedahBatool changed the base branch from main to sg-may-release May 28, 2025 18:09
@MaedahBatool MaedahBatool merged commit d6624bf into sg-may-release May 28, 2025
9 checks passed
@MaedahBatool MaedahBatool deleted the bc-updates-may28 branch May 28, 2025 18:39
MaedahBatool added a commit that referenced this pull request May 28, 2025
MaedahBatool added a commit that referenced this pull request May 28, 2025
Reverts #1159

---------

Signed-off-by: Emi <emi@sourcegraph.com>
Co-authored-by: Vincent <evict@users.noreply.github.com>
Co-authored-by: Louis Jarvis <31862633+loujar@users.noreply.github.com>
Co-authored-by: Jacob Pleiness <jdpleiness@users.noreply.github.com>
Co-authored-by: Marc <7050295+marcleblanc2@users.noreply.github.com>
Co-authored-by: Camden Cheek <camden@ccheek.com>
Co-authored-by: Anish Lakhwara <anish+github@lakhwara.com>
Co-authored-by: Warren Gifford <warrenbruceg@gmail.com>
Co-authored-by: Jacob Pleiness <jacob.pleiness@sourcegraph.com>
Co-authored-by: Gabe Torres <69164745+gabtorre@users.noreply.github.com>
Co-authored-by: Stomzy <45337015+airamare01@users.noreply.github.com>
Co-authored-by: Justin Dorfman <justin.dorfman@sourcegraph.com>
Co-authored-by: PriNova <31413214+PriNova@users.noreply.github.com>
Co-authored-by: Zahid Ali <m.zahidalidev@gmail.com>
Co-authored-by: mibali <111276665+mibali@users.noreply.github.com>
Co-authored-by: Noah Berman <38916274+noah-berman@users.noreply.github.com>
Co-authored-by: derek-feriancek-sg <derek.feriancek@sourcegraph.com>
Co-authored-by: Alex Jean-Baptiste <alex.jean-baptiste@sourcegraph.com>
Co-authored-by: morgangauth <113058716+morgangauth@users.noreply.github.com>
Co-authored-by: Stefan Hengl <stefan.hengl@gmail.com>
Co-authored-by: sourcegraph-bot-devx <127119266+sourcegraph-bot-devx@users.noreply.github.com>
Co-authored-by: Anish Lakhwara <anish+git@lakhwara.com>
Co-authored-by: Cody Tubbs <codytubbs@users.noreply.github.com>
Co-authored-by: Enrique Gonzalez <enrique@sourcegraph.com>
Co-authored-by: Daniel Marques <dlmarques@me.com>
Co-authored-by: Alex Romano <alexromano12@gmail.com>
Co-authored-by: rakeshjosh2003 <102702631+rakeshjosh2003@users.noreply.github.com>
Co-authored-by: Michael Lin <mlzc@hey.com>
Co-authored-by: Varun Gandhi <varun.gandhi@sourcegraph.com>
Co-authored-by: Petri-Johan Last <petri.last@gmail.com>
Co-authored-by: Michael Bahr <1830132+bahrmichael@users.noreply.github.com>
Co-authored-by: Dan Adler <dadlerj@users.noreply.github.com>
Co-authored-by: Dan Adler <5589410+dadlerj@users.noreply.github.com>
Co-authored-by: Justin Dorfman <justindorfman@gmail.com>
Co-authored-by: Valery Bugakov <skymk1@gmail.com>
Co-authored-by: Aravind Ramaraju <51247042+aramaraju@users.noreply.github.com>
Co-authored-by: Beatrix <68532117+abeatrix@users.noreply.github.com>
Co-authored-by: graceshih-sg <grace.shih@sourcegraph.com>
Co-authored-by: Joe Chen <jc@unknwon.io>
Co-authored-by: Alex Kemper <alex.j.kemper@gmail.com>
Co-authored-by: Matthew Manela <mmanela@users.noreply.github.com>
Co-authored-by: Camden Cheek <camden@sourcegraph.com>
Co-authored-by: William Bezuidenhout <william.bezuidenhout@sourcegraph.com>
Co-authored-by: Will Dollman <will.dollman@sourcegraph.com>
Co-authored-by: amenne <amenne@users.noreply.github.com>
Co-authored-by: LeweyM <36539330+LeweyM@users.noreply.github.com>
Co-authored-by: Travis Lyons <travis.lyons@sourcegraph.com>
Co-authored-by: steve sadler <rs5sadler@gmail.com>
Co-authored-by: Kalan <51868853+kalanchan@users.noreply.github.com>
Co-authored-by: Erik Seliger <erikseliger@me.com>
Co-authored-by: kelsey-brown <80273085+kelsey-brown@users.noreply.github.com>
Co-authored-by: steve sadler <steve.sadler@sourcegraph.com>
Co-authored-by: Saad Irfan <mrsaadirfan@gmail.com>
Co-authored-by: Maham Codes <33153838+MahamDev@users.noreply.github.com>
Co-authored-by: Andrew Norrish <110418926+anorrish@users.noreply.github.com>
Co-authored-by: Anton Sviridov <anton.sviridov@sourcegraph.com>
Co-authored-by: Eugenio Sanchez <eugenio.sanchez@sourcegraph.com>
Co-authored-by: Taras Yemets <yemets.taras@gmail.com>
Co-authored-by: Peter Guy <peter.guy@sourcegraph.com>
Co-authored-by: Chris Concannon <chris.concannon@sourcegraph.com>
Co-authored-by: Adi Ranjan <adi.ranjan@sourcegraph.com>
Co-authored-by: Keyukemi Ubi <65344874+Keyukemi@users.noreply.github.com>
Co-authored-by: Emi <emi@hexops.com>
Co-authored-by: Geoffrey Gilmore <geoffrey@sourcegraph.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.