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

Improve documentation #54

Open
ghost opened this issue Jan 6, 2021 · 1 comment
Open

Improve documentation #54

ghost opened this issue Jan 6, 2021 · 1 comment

Comments

@ghost
Copy link

ghost commented Jan 6, 2021

Hey guys. I've been trying to use Janusgraph with FDB and have so far been quite unsuccessful following the README.md. I feel there are quite a few areas that need to be better addressed in the documentation;

  • install.sh will attempt to backup (cp) janusgraph.sh which only exists in the full versions of Janusgraph, and will therefor leave an error message. If the user should only be using the full version, then this should be explicit, otherwise an if statement might be more appropriate for this line.
  • install.sh attempts to copy lib/* to ${JANUS_INSTALL_PATH}/ext. This folder doesn't exist if built, and therefor will trigger an error.
  • The binary release of 0.1.0 does not seem to be the same as that of building 0.1.0. This should be obvious, since the binary is 2 years old, but the version number is the same. Executing install.sh from the binary release on JanusGraph 0.5.2 resulted in a broken gremlin.sh. Building the repository then executing install.sh fixed this issue.
  • Is the compatibility matrix in the description of binary release 0.1.0 outdated? At first I thought it was, being that it's a 2 year old release, and README.md claims version 0.1.0 can be used with newer versions of JanusGraph. But since it broke gremlin.sh, whereas the built version did not, perhaps it isn't outdated, and the version for the current state of the adapter should be bumped? Either that or the compatibility matrix for the release should be removed, as it conflicts with what the README says.
  • README claims there are multiple binary releases, however there is only a single one.

I love JanusGraph and FDB and would love to use them together, but so far I've had no success, and following the README left me with little confidence that this adapter is ready. I feel there must be some user-error that's causing me issues, but I'm finding it hard to pinpoint. Either way, I feel new users could benefit from better documentation. I'm happy to provide dockerfiles to demonstrate any of the above mentioned issues.

@baiwfg2
Copy link

baiwfg2 commented Oct 14, 2021

See https://stackoverflow.com/questions/56128805/how-to-start-janusgraph-server-with-foundationdb-on-a-different-host-or-containe/

I made it work on FDB 6.0.15 + JG 0.3.0 + adapter 0.1.0 under docker env, but fails on higher version. Also hope to direct how to make JG 0.5.2 + adapter 0.1.0 + FDB 6.2.22 work

@farodin91

FDB Storage Adapter JanusGraph FoundationDB
0.1.0 0.5.2 6.2.22

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

No branches or pull requests

1 participant