-
Notifications
You must be signed in to change notification settings - Fork 7
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
Handle docs for both graphDB and Stardog via tabs on the public docs #74
Comments
surchs
added
the
flag:schedule
Flag issue that should go on the roadmap or backlog.
label
Sep 20, 2023
rmanaem
removed
the
flag:schedule
Flag issue that should go on the roadmap or backlog.
label
Sep 20, 2023
This was referenced Sep 21, 2023
Because we now render a .tsv table from the api in the docs: https://github.com/neurobagel/api/blob/main/docs/api_environment_variables.tsv, we'll have to go back later and update this table as well. And we may have to create two flavours of this table, one for each graph deployment |
3 tasks
github-project-automation
bot
moved this from Review - Active
to Review - Done
in Neurobagel
Sep 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Because of their restrictive licensing policy, we are currently transitioning away from Stardog as our backend but haven't settled on a default replacement: neurobagel/planning#9
In the meantime we suggest people use graphDB as the graph backend. We therefore started maintaining two different sysadmin setup instructions, one for Stardog and one for graphDB as backends. Not fun, but necessary. We also maintain these two sets of instructions in two different places: Stardog on the public docs, graphDB in the internal docs. That's bad and confusing (see e.g. here: #67).
Let's
Also, we should make the code syntax highlighting consistent across this docs page.
This should hopefully make it easier for us to make clear what aspects of the setup instructions are shared between the two backends, and which aspects are unique and different.
The text was updated successfully, but these errors were encountered: