JanusGraph / JanusGraph/janusgraph
documentation links should not use hardcoded TP version
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 5.8k
- Forks
- 1.2k
- Avg merge
- 13h 53m
- Merged PRs (30d)
- 6
Description
As discussed in PR #578 the documentation links in the example README markdown files are hardcoded for a specific TinkerPop version. The examples are packaged within the distribution, so it might be better to convert the markdown into an HTML file to be packaged in the distribution, making sure to filter/replace the versions with the build-time version number.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the example README markdown files and the packaging configuration for the distribution. Identify the hardcoded TinkerPop version links and the build-time version value used by the project. Done means the packaged example documentation uses the distribution's version rather than a fixed version.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100