JanusGraph / JanusGraph/janusgraph

Add index feature support matrix documentation for different backends

Open
#319 0 comments 1 reaction 0 assignees View on GitHub
area/docs
Dominant language
Java
Stars
5.8k
Forks
1.2k
Avg merge
13h 53m
Merged PRs (30d)
6

Description

Currently the mixed index documentation is heavily ES centric.

Some examples:
a) http://docs.janusgraph.org/0.1.0/index-parameters.html
21.1.3. Full text and string search
**"If you are using ElasticSearch it is possible to..."**
b) http://docs.janusgraph.org/0.1.0/direct-index-query.html
22.1. Query String
**"Elasticsearch and Lucene support ..."**
c) http://docs.janusgraph.org/0.1.0/search-predicates.html
20.7. Collections
**"If you are using Elasticsearch then you can index properties with SET and LIST cardinality"**

This does not mention Solr anywhere leaving anyone trying to use those features with Solr wondering if they actually work.
Even if they do NOT work if would be better to get this information explicitly from the docs, and not by trial and error.

This could be improved by e.g. providing a feature matrix support table with different backends stated in the columns and features states in the rows.

Contributor guide

Open the contributing guide

Research direction

Start with the index-parameters, direct-index-query, and search-predicates documentation sections linked in the issue. Check the documented feature behavior for each supported index backend, including Solr, against the relevant backend capabilities. Done means the docs include a clear support matrix and explicitly identify unsupported or unverified combinations.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch
Domain
databases, documentation, search
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.