Repository navigation
docs: run quickstart script from Git Bash or WSL on Windows; fix macOS wizard note - #1887
Open
ShryukGrandhi wants to merge 1 commit into
Conversation
…S wizard note Signed-off-by: ShryukGrandhi <85529990+ShryukGrandhi@users.noreply.github.com>
Preview approval requiredThis pull request comes from a fork, so Mintlify won't build a preview until someone with write access approves commit |
This branch has not been deployed
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.
Purpose of the change
Fix two platform-specific errors in the install docs.
Description
docs/getting_started/quickstart.mdx: the Windows tab told users to run thedownload snippet in PowerShell, but the last line runs
./memmachine-compose.sh, which is a bash script and can't run there. TheWindows tab now says to run the setup from Git Bash or a WSL terminal with
Docker Desktop running, uses the same bash snippet as Linux/macOS, and notes
that WSL users need Docker Desktop's WSL integration turned on. The
"Management Scripts" section now says Windows users should run those commands
from Git Bash or WSL too.
docs/install_guide/configure_wizard.mdx: the macOS line said the wizardinstalls Java and Neo4j with
brew.MacosInstallerdoesn't callbrew. Itdownloads and extracts the JDK and Neo4j tar.gz archives, the same way the
Linux installer does. The line now says that.
Fixes/Closes
Fixes #1870
Type of change
How Has This Been Tested?
MacosInstaller.install_and_start_neo4jinpackages/server/src/memmachine_server/installation/memmachine_configure.pyand confirmed it downloads and extracts tar.gz archives. Nothing in
installation/callsbrew..mdxfiles with@mdx-js/mdxv3. Both parse withouterrors.
I haven't run the steps on a Windows machine.
Checklist
Further comments
A PowerShell version of
memmachine-compose.shwas the other option in theissue. I left it out to keep this change docs-only.