Skip to content

Conversation

@surchs
Copy link
Contributor

@surchs surchs commented Jan 6, 2026

Changes proposed in this pull request:

These changes correspond to changes in the recipe repo: neurobagel/recipes#162

  • changed the configure a node docs page
    • focus on "guide" style, meant to be read top to bottom
    • only two launch profiles: node and portal
    • only one proxy server recipe (nginx+acme) to keep it simple
    • reference of environment varibles moved to the end. more of a regular "docs" section
    • section on "security relevant variables" moved inside the "node" profile
    • additional section for how to launch the services behind existing proxy
    • strongly encourage each deployment starts from a fresh recipe clone (no longer "extension" of getting started)
  • simplified the getting started docs page because prod deployments now always start from a fresh deployment
    • now just about getting user started locally (prod deployments are now completely separate)
    • replaced most clarifications and context with top-level admonition about prod deployment

Note

  • NB_API_QUERY_URL is now only used for "getting started" and thus set to localhost:8000 to make the initial launch easier. For prod deployments, NB_API_QUERY_URL is composed automatically from other ENV variables
  • there is now a new, dedicated compose file for "behind existing proxy". This makes setup easier and keeps the docs aligned.

Checklist

Please leave checkboxes empty for PR reviewers

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF]) see our Contributing Guidelines for more info)
  • PR links to GitHub issue with mention Closes #XXXX
  • Checks pass
  • If an existing page was renamed or deleted, redirects have been added to the mkdocs.yml config

@netlify
Copy link

netlify bot commented Jan 6, 2026

Deploy Preview for neurobagel-documentation ready!

Name Link
🔨 Latest commit 17305d6
🔍 Latest deploy log https://app.netlify.com/projects/neurobagel-documentation/deploys/695eed588613470008379685
😎 Deploy Preview https://deploy-preview-352--neurobagel-documentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@surchs surchs marked this pull request as ready for review January 7, 2026 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update docs for production

2 participants