Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENH] Add example config for deploying a node behind NGINX and clarify data uploading #240

Merged
merged 6 commits into from
Nov 13, 2024

Conversation

alyssadai
Copy link
Contributor

@alyssadai alyssadai commented Nov 13, 2024

Changes proposed in this pull request:

  • Add new section "Behind a proxy" with example docker-compose.yml including NGINX+ACME
  • Restructure "Updating data in the graph" section slightly, and link to it more explicitly in the Getting Started steps, to further centralize and make intuitive the key steps for setting up a database. This:
  • Differentiate names of sections relating to updating graph data to avoid confusion, and fix outdated links pointing to manual setup instructions
  • Fix some indenting in admonitions

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

Copy link

netlify bot commented Nov 13, 2024

Deploy Preview for neurobagel-documentation ready!

Name Link
🔨 Latest commit 092498c
🔍 Latest deploy log https://app.netlify.com/sites/neurobagel-documentation/deploys/67352de09cb0650008d27ffe
😎 Deploy Preview https://deploy-preview-240--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 site configuration.

@alyssadai alyssadai marked this pull request as ready for review November 13, 2024 21:57
@alyssadai alyssadai requested a review from surchs November 13, 2024 21:58
@alyssadai alyssadai changed the title [ENH] Add example config for deploying Neurobagel services behind NGINX [ENH] Add example config for deploying Neurobagel services behind NGINX and clarify data uploading Nov 13, 2024
@alyssadai alyssadai changed the title [ENH] Add example config for deploying Neurobagel services behind NGINX and clarify data uploading [ENH] Add example config for deploying a node behind NGINX and clarify data uploading Nov 13, 2024
Copy link
Contributor

@surchs surchs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @alyssadai for addressing this quickly. Text looks great.

I'm neutral on adding the 4th point to the getting-started section, but OK to go with your opinion here (we can also ask users to tell us if that's clear).

One suggestion, then 🧑‍🍳

docs/config.md Outdated Show resolved Hide resolved
docs/maintaining.md Outdated Show resolved Hide resolved
Co-authored-by: Sebastian Urchs <[email protected]>
@alyssadai alyssadai merged commit ff0919f into main Nov 13, 2024
6 checks passed
@alyssadai alyssadai deleted the add-reverse-proxy-compose-recipe branch November 13, 2024 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants