Drasi Server Getting Started Fixes#225
Merged
Merged
Conversation
- Add --gc, --noHTTPCache, and --ignoreCache flags to the hugo server command so contributors get cleaner rebuilds and fewer stale-cache surprises when previewing changes locally. - Drop --remote from the submodule update command; pulling the submodule's tracked commit (rather than its remote tip) keeps local builds reproducible and aligned with what CI builds. - Tidy markdown formatting: add blank lines after headings, switch the pre-requisites bullet to a dash, and add a trailing newline at EOF. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Tighten the wording for two prerequisites on the Drasi Server build-from-source page so each entry consistently explains *why* the tool is needed: - Rust 1.88+: 'For building' → 'Needed to build Drasi Server', matching the phrasing pattern used by the other bullets. - curl: 'Used in later tutorial steps' → 'Used to interact with Drasi Server's REST API during the tutorial', so readers know what curl is actually for rather than a vague forward reference. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The file literally named '<path to affected file(s)>' was added in commit b891392 (PR #205, 'Add two new blog post entries to Media Coverage page') as an unfilled placeholder from a buggy AI revert workflow. Its sole content was 'Reverted commit 0970db2', referencing a commit hash that does not exist in this repo. The file has no functional purpose and removing it cleans up the working tree. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Drop the --gc, --noHTTPCache, and --ignoreCache flags that were added to the dev-server command in 9cc7bec. They cause render failures during incremental rebuilds: - --gc is documented as a post-build cleanup for one-shot production builds (`hugo`), not the watch-mode dev server. Combined with Docsy's `partialCached "head-css.html"` wrapper around the SCSS pipeline, --gc deletes the compiled CSS from resources/_gen between rebuilds because the cached partial doesn't re-mark the asset as 'in use'. The next rebuild then fails with 'execute of template failed at <.RelPermalink>: error calling RelPermalink: file does not exist'. - --noHTTPCache and --ignoreCache force Hugo to re-fetch remote resources and bypass the getJSON/getCSV HTTP cache on every rebuild, which just slows the dev loop down without benefitting contributors. Restore the original `hugo server --disableFastRender` command, which is sufficient for previewing changes that affect multiple pages. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Use 'Drasi Server' branding instead of 'drasi-server' in prose - Update example version output to reflect v0.2.0 with rustc and plugin-sdk version details Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The recent plugin-driven config wizard walkthrough had grown too involved to remain in the quick-start path. Replace the inline wizard walkthrough in Step 3 with a simple instruction to copy `examples/getting-started/configs/getting-started-step-3.yaml` to the tutorial root as `getting-started.yaml`, plus a Tip linking to the new 'Create Configuration with the Wizard' how-to guide for users who want to create their config from scratch. - Rewrite Step 3 body: brief intro of what the config defines, copy command (bash / PowerShell tabs), Tip pointing to the wizard how-to - Update the intro table row for Step 3 (10 min -> 3 min) and reword its description to match the new flow - Update the 'What You've Learned' Configuration row to reflect that the tutorial starts from a provided config (with a mention of the wizard as an alternative) - Drop the now-redundant note about comparing against getting-started-step-3.yaml, since that file IS the starting config Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…eps 4-6 Sidebar / nav cleanup for setup variants: - Add 'toc_hide: true' to the four setup-variant pages (build-from-source, dev-container, download-binary, github-codespace) so they no longer appear in the Docsy left sidebar. They remain reachable via the setup cards on the Getting Started index page and by direct URL. - Point the 'Continue with the Tutorial' button on each setup page at the Step 1 setup anchor (#setup) instead of #database, so the reader lands on the same Step 1 section they came from after completing the chosen setup. Prose polish in Steps 4, 5, and 6 of getting-started/_index.md: - Use 'Continuous Query' consistently in headings and body text instead of the bare 'Query'. - Expand the explanation of how multiple Continuous Queries can share the same Source, and how a Reaction can subscribe to multiple Continuous Queries. - Step 5: add a new 'Installing the SSE Reaction' section that walks the reader through installing the SSE Reaction plugin via the REST API, and split out the SSE CLI usage into its own section. - Tighten several intro and result blurbs (e.g. `Count` updates, `persistConfig` Tip, time-based detection framing). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Replace the meta 'this tutorial teaches you…' opening with a concrete problem statement (reacting the instant data changes, plus a real-world Kubernetes non-compliant-image example), the no-polling differentiator, and an explicit end-state describing what the reader will have working. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Fold positioning insights into drasi-context.yaml: add always_say phrases, incremental_maintenance and no_application_code differentiators, an explaining_value_to_developers section, and related FAQ entries. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Introduce the all-messages Continuous Query in Step 3 with a structural walkthrough and a note on graph queries over a relational source, so readers meet a Continuous Query before Step 4 - Add commentary on the ADD/UPDATE/DELETE Log Reaction output highlighting the no-code experience - Move component-functionality tips (init wizard, Log/SSE Reaction templates, persistConfig) into a focused Next Steps section - Convert blockquote callouts to alert shortcodes with percent delimiters so embedded markdown renders - Normalize terminal references (Terminal 1/2/3), add 'of 6' to step headings, add 'Before you begin' and concepts boxes - Remove the manual 'Create Docker network' step from the download-binary and build-from-source setups - Fix stale version output to drasi-server 0.2.0 and mark Download Binary as recommended Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Frame the by-hand alternative (CDC, queue, stream processor, state store, scheduler) in the intro and closing summary, contrasting it with Drasi's queries-and-configuration approach - Add per-step contrast at the Step 4, 5, and 6 checkpoints so the 'what you didn't have to build' theme is consistent throughout - Add the Create Configuration with the Wizard how-to page and comment out its card on the configuration index for now Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refines the Drasi Server documentation to make the Getting Started flow clearer and more up to date, while also introducing an (explicitly draft) configuration-wizard how-to and updating the authoritative context file.
Changes:
- Restructures the Drasi Server Getting Started tutorial to start from a provided config file, clarifies step-by-step guidance, and adds more explanatory context.
- Updates setup sub-guides (Codespace/Dev Container/Download Binary/Build from Source) with
toc_hide: true, refreshed version output, and simplified steps (e.g., removing manual Docker network creation). - Adds a new draft how-to for generating config via
drasi-server initand updatesdocs/static/drasi-context.yamlto version0.5.1.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 12 comments.
Show a summary per file
| File | Description |
|---|---|
| readme.md | Minor formatting/command updates for building the docs locally. |
| docs/static/drasi-context.yaml | Updates authoritative messaging/context version and adds new key phrases/differentiators/FAQ items. |
| docs/content/drasi-server/how-to-guides/configuration/create-config-with-wizard/_index.md | Adds a new draft wizard walkthrough guide with step-by-step prompts and examples. |
| docs/content/drasi-server/how-to-guides/configuration/_index.md | Adds (commented-out) card for the new wizard guide. |
| docs/content/drasi-server/getting-started/github-codespace/_index.md | Adds toc_hide, updates version example, updates “Continue” anchor. |
| docs/content/drasi-server/getting-started/download-binary/_index.md | Adds toc_hide, removes Docker network step, updates “Continue” anchor. |
| docs/content/drasi-server/getting-started/dev-container/_index.md | Adds toc_hide, updates version example, updates “Continue” anchor. |
| docs/content/drasi-server/getting-started/build-from-source/_index.md | Adds toc_hide, clarifies prerequisites text, updates version example, removes Docker network step, updates “Continue” anchor. |
| docs/content/drasi-server/getting-started/_index.md | Major rewrite/clarification of the tutorial flow, adds plugin install step for SSE, updates copy and structure across steps. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ruokun-niu
reviewed
Jun 1, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…nary Change 'checkmark' to 'check mark' in the wizard guide and add 'cp' and 'cron' to the custom spell-check word list. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
ruokun-niu
approved these changes
Jun 1, 2026
danielgerlag
approved these changes
Jun 2, 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.
This pull request updates and improves the Drasi Server documentation, focusing on clarifying setup steps, updating version references, and introducing a new (draft) guide for using the configuration wizard. The changes make the getting started guides more accurate and user-friendly, and prepare for future documentation about configuration via the interactive wizard.
Documentation improvements:
toc_hide: trueto all setup guide markdown files to hide autogenerated tables of contents and improve page layout. [1] [2] [3] [4]drasi-server 0.2.0instead of0.1.0). [1] [2] [3]Getting started workflow simplification:
#setup) in all setup guides. [1] [2] [3] [4]Configuration documentation:
drasi-server initwizard, including step-by-step walkthroughs and screenshots. This is not yet linked in the main configuration guide, but the card for it is present in commented form. [1] [2]Other: