neurobagel / documentation

The neurobagel documentation
http://neurobagel.org/
MIT License
10 stars 6 forks source link

Confusion about API vs Federation API during deployment #211

Open gdevenyi opened 3 months ago

gdevenyi commented 3 months ago

Description

The documentation does not make clear the differences between the full-stack federated and non-federated installations, resulting in confusion as to which API path should be proxied in a proxy configuration and which API endpoint the query tool should be pointed at.

Relevant documentation pages

https://neurobagel.org/getting_started/

Additional details

No response

gdevenyi commented 3 months ago

The form deleted some of what I typed. Cool.

Re-adding.

There should be some kind of state-based description of how the moving parts work under the different 'stack' setups. "query tool makes a call to X which makes a call to Y which makes a call to Z"

So that the person doing configuration can understand how each moving part talks to each other and can test them.

github-actions[bot] commented 3 weeks ago

We want to keep our issues up to date and active. This issue hasn't seen any activity in the last 75 days. We have applied the _flag:stale label to indicate that this issue should be reviewed again. When you review, please reread the spec and then apply one of these three options: