Update server installation docs#251
Open
ruokun-niu wants to merge 2 commits into
Open
Conversation
Signed-off-by: ruokun-niu <ruokunniu@gmail.com>
Signed-off-by: ruokun-niu <ruokunniu@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates Drasi Server installation documentation to match recent release/workflow changes and the server’s strict camelCase configuration schema, reducing user confusion and invalid setup steps.
Changes:
- Updates Windows download URLs/filenames for the Drasi Server and SSE CLI binaries to match current release artifacts.
- Aligns “build from source” native dependency prerequisites with the Getting Started guide (adds
jqon macOS; switches Windows guidance to MSVC Build Tools + pinned Rust MSVC toolchain). - Fixes invalid Docker configuration examples by replacing snake_case keys with the correct camelCase keys (
stateStore,logLevel).
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/shared-content/installation/drasi-server/download-sse-cli-binary.md | Fixes Windows SSE CLI download output filename to drasi-sse-cli.exe. |
| docs/shared-content/installation/drasi-server/download-binary.md | Updates Windows Server binary download URL to the -windows-msvc.exe artifact name. |
| docs/shared-content/installation/drasi-server/build-from-source-prereqs.md | Aligns macOS/Windows build prerequisites with the Getting Started build-from-source instructions. |
| docs/content/drasi-server/how-to-guides/installation/install-with-docker/_index.md | Corrects Docker config examples to use validated camelCase keys (stateStore, logLevel). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
danielgerlag
approved these changes
Jul 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
When we previously renamed the windows binaries in the release workflow for drasi-server, we only updated the installation scripts in the getting started tutorial, but forgot to update the general installation docs for drasi-server.
This PR corrects outdated and inconsistent details across the Drasi Server installation docs. It updates the binary download instructions to match the latest release (Windows server binary renamed to drasi-server-x86_64-windows-msvc.exe, and fixes the SSE CLI Windows output filename), aligns the "build from source" native-dependency prerequisites with the getting-started guide (MSVC toolchain on Windows, jq on macOS), and fixes invalid config field names in the Docker guide (state_store→stateStore, log_level→logLevel)
Type of change
Fixes: #250