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

Handle docs for both graphDB and Stardog via tabs on the public docs #74

Closed
surchs opened this issue Sep 11, 2023 · 2 comments · Fixed by #92
Closed

Handle docs for both graphDB and Stardog via tabs on the public docs #74

surchs opened this issue Sep 11, 2023 · 2 comments · Fixed by #92
Assignees

Comments

@surchs
Copy link
Contributor

surchs commented Sep 11, 2023

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

  • keep both backend instructions in the public docs by merging the graphDB docs into the public docs
  • let users switch between their desired backend using the linked tabs feature
  • give some context for why there are two backends and how to pick
  • not write any new docs, but just refactor the existing docs

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.

@surchs surchs added the flag:schedule Flag issue that should go on the roadmap or backlog. label Sep 20, 2023
@rmanaem rmanaem moved this to Backlog in Neurobagel Sep 20, 2023
@rmanaem rmanaem removed the flag:schedule Flag issue that should go on the roadmap or backlog. label Sep 20, 2023
@surchs surchs moved this from Backlog to Specify - Active in Neurobagel Sep 22, 2023
@surchs surchs moved this from Specify - Active to Specify - Done in Neurobagel Sep 22, 2023
@surchs surchs moved this from Specify - Done to Implement - Active in Neurobagel Sep 22, 2023
@surchs surchs self-assigned this Sep 22, 2023
@surchs
Copy link
Contributor Author

surchs commented Sep 22, 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

@alyssadai
Copy link
Contributor

@surchs just a heads up that I noticed a typo in the existing instructions for Stardog, and have opened an issue here #93.

I'll leave it up to you if you want to address it as part of this PR, since you're updating that same page 🙂

@surchs surchs moved this from Implement - Active to Implement - Done in Neurobagel Sep 25, 2023
@rmanaem rmanaem moved this from Implement - Done to Review - Active in Neurobagel Sep 25, 2023
@github-project-automation 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
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants