apache / apache/maven-indexer

[MINDEXER-232] There should be constants for the different index creator types and these should be documented somewhere

Open
#658 1 comment 0 reactions 0 assignees View on GitHub
maintenance priority:major
Dominant language
Java
Stars
74
Forks
69
Avg merge
14h 8m
Merged PRs (30d)
6

Description

**[Martin Todorov](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=carlspring)** opened **[MINDEXER-232](https://issues.apache.org/jira/browse/MINDEXER-232?redirect=false)** and commented

# Description

There don't appear to be any constants for the possible index creator types. They also don't appear to be documented. This makes it harder to understand what index creator types exist and how they can be used.

# Task List

* (off) Define constants for the different index creator types.
* (off) Refactor the code so that it uses these constants.
* (off) Add documentation that outlines what these index creators types are used for.
* (off) Clarify what the default indexers are.
* (off) Clarify what indexers are used to create the indexes for Maven Central.

---
No further details from [MINDEXER-232](https://issues.apache.org/jira/browse/MINDEXER-232?redirect=false)

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names no files or tests. Start by locating the existing index creator type definitions and their call sites, then identify the default and Maven Central indexers. Done means named constants replace the current type references and documentation explains each type and those defaults.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.