docs(installation): clarify download/staging copy + collapse init script render#31
Merged
Conversation
Three small wording clarifications + a render improvement so the ~400-line init script doesn't dominate the install page. Clarifications (mjohns): - "attaches three files" → "attaches three files (among others)" — set expectation that the release page has more than just these three. - "**not** uploaded to the bundle Volume" → "**not** included in the bundle (from above)" — reads more naturally given the prior section introduced the bundle. - Step 3.1: name VOL_DIR as a candidate staging location for the init script itself (one less decision for the reader). Render improvement: - Replace the always-expanded CodeFromTest with a 10-line preview + native `<details>` disclosure containing the full script. Avoids burying the rest of the page under the init script when readers are scrolling through the install flow; opt-in to expand for full review. Co-authored-by: Isaac
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.
Summary
Doc-only PR. Two kinds of changes to
docs/docs/installation.mdx:Clarifications (three small wording tweaks):
VOL_DIRas a candidate staging location for the init script itself, so readers don't have to invent a path.Render improvement — the inline
<CodeFromTest code={initScript} … />was rendering all ~400 lines ofgeobrix-gdal-init.sh, dominating the install page for readers scrolling past it. Replaced with a 10-line preview + native HTML<details>disclosure containing the full script:The MDX expression slicing happens at render time against the raw-loader string, so the preview stays in sync with the script automatically — no manual sync needed.
Test plan
gbx:docs:dev— verify the preview renders as the first 10 lines and the disclosure is collapsed by default + expands cleanly to the full script.[scripts/geobrix-gdal-init.sh](https://github.com/databrickslabs/geobrix/blob/main/scripts/geobrix-gdal-init.sh)in step 3 still resolves (it's unchanged but worth a glance).<details>is native HTML so Docusaurus's default theme handles it, but worth one mobile-width sanity check.This pull request and its description were written by Isaac.