Updated Drasi Server "Build from Source" installation guide and added CI verification - #262
Draft
ruokun-niu wants to merge 10 commits into
Draft
Updated Drasi Server "Build from Source" installation guide and added CI verification#262ruokun-niu wants to merge 10 commits into
ruokun-niu wants to merge 10 commits into
Conversation
Signed-off-by: Ruokun Niu <ruokunniu@microsoft.com>
Signed-off-by: Ruokun Niu <ruokunniu@microsoft.com>
Signed-off-by: Ruokun Niu <ruokunniu@microsoft.com>
Signed-off-by: Ruokun Niu <ruokunniu@microsoft.com>
Signed-off-by: Ruokun Niu <ruokunniu@microsoft.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR modernizes the Drasi Server “Build from Source” documentation into an install-based flow, adds CI to continuously verify the documented commands across platforms, expands the mounted tutorial content, and applies Hugo-template updates to eliminate deprecation warnings.
Changes:
- Reworked build-from-source and prerequisites docs (including snippet IDs) and added a new “Install the SSE CLI” guide.
- Added a GitHub Actions workflow + extraction script to execute the docs’ fenced-command snippets on Linux/macOS/Windows and report scheduled failures.
- Updated Hugo layouts/config to address deprecations and mount additional tutorial content into the site.
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/shared-content/installation/drasi-server/download-binary.md | Updates example output to reflect newer Rust toolchain. |
| docs/shared-content/installation/drasi-server/build-from-source-prereqs.md | Adds platform-specific prereqs and environment guidance; tags code fences for CI extraction. |
| docs/layouts/shortcodes/term.html | Replaces deprecated site.Data usage with hugo.Data. |
| docs/layouts/shortcodes/glossary-terms.html | Replaces deprecated site.Data usage with hugo.Data. |
| docs/layouts/docs/baseof.html | Updates deprecated language direction property usage. |
| docs/layouts/baseof.html | Adds a project override of the theme base layout (contains a blocking template bug noted in comments). |
| docs/layouts/_partials/head-css.html | Adds a project override to address Hugo/CSS pipeline deprecations/behavior. |
| docs/content/drasi-server/how-to-guides/installation/install-sse-cli/_index.md | Adds a new installation guide for the SSE CLI (binary + source). |
| docs/content/drasi-server/how-to-guides/installation/build-from-source/_index.md | Switches to cargo install --root . flow, adds verification steps, raises Rust requirement, adds snippet IDs. |
| docs/content/drasi-server/how-to-guides/installation/_index.md | Adds an installation card linking to the SSE CLI guide. |
| docs/config.toml | Mounts additional tutorials via Hugo modules and updates language config key. |
| .github/workflows/verify-build-from-source.yml | New CI workflow that executes commands extracted from docs and files issues on scheduled failures. |
| .github/scripts/extract-doc-commands.js | New script to extract fenced-code-block commands by stable snippet ID. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Ruokun Niu <ruokunniu@microsoft.com>
Signed-off-by: Ruokun Niu <ruokunniu@microsoft.com>
Signed-off-by: Ruokun Niu <ruokunniu@microsoft.com>
Signed-off-by: Ruokun Niu <ruokunniu@microsoft.com>
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
Reworks the Drasi Server Build from Source installation path into a documented, install-based flow and adds CI that verifies the documented commands actually work across platforms. Also mounts the remaining Drasi Server tutorials into the site and clears Hugo deprecation warnings.
Changes
Installation guides
docs/content/drasi-server/how-to-guides/installation/build-from-source/_index.md): switched from rawcargo build/cargo runtocargo install --path . --root .producing a stable./bin/drasi-server; bumped the required Rust to 1.95+; added verify steps and an "iterating on source" tip. Tagged the documented code fences with stable ids (clone-drasi-server,build-drasi-server,verify-drasi-server) so CI can extract them.docs/shared-content/installation/drasi-server/build-from-source-prereqs.md): added a stable id to the Windows block and made thewingetcommand non-interactive (--source winget,--accept-*-agreements,--disable-interactivity) so it works unattended.docs/content/drasi-server/how-to-guides/installation/install-sse-cli/_index.md): prebuilt-binary and build-from-source options, withbuild-sse-cli/verify-sse-clisnippet ids.docs/content/drasi-server/how-to-guides/installation/_index.md) and a minor tweak todocs/shared-content/installation/drasi-server/download-binary.md.CI: verify the guide never drifts
.github/workflows/verify-build-from-source.yml): runs the documented commands (extracted at build time, never hardcoded) on a matrix of Linux, macOS (Apple Silicon), macOS (Intel,macos-26-intel), and Windows. Windows uses a dedicated PowerShell step. Triggers on PR (to the guide/script), manual dispatch, and a weekly schedule.report-failurejob opens (or comments on) a tracking issue only when the scheduled run fails, so upstreamdrasi-serverdrift doesn't go unnoticed..github/scripts/extract-doc-commands.js): pulls commands from the Markdown by fenced-code-block id, with alinux/macos/windowsmanifest.Docs site
learning-drasi-servermodule indocs/config.tomlso they render in the site nav (previously only Getting Started was mounted).Hugo deprecation fixes
.Language.LanguageDirection→.Language.Directionindocs/layouts/docs/baseof.html, plus project overrides of the theme'sdocs/layouts/baseof.htmlanddocs/layouts/_partials/head-css.html(docsy is a pinned submodule)..Site.Data→hugo.Dataindocs/layouts/shortcodes/glossary-terms.htmlanddocs/layouts/shortcodes/term.html.languages.en.languageName→labelindocs/config.toml.Build now reports 0 deprecation warnings.
Type of change
Fixes: #260 #259