quickwit-oss/quickwit

Warn user when using local filesystem as default index root URI

Open

#1,990 opened on Sep 21, 2022

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)Rust (580 forks)github user discovery
enhancementgood first issue

Repository metrics

Stars
 (11,532 stars)
PR merge metrics
 (Avg merge 5d 18h) (41 merged PRs in 30d)

Description

We could print a warning with a link to the docs outlining the limitations when using the filesystem as datadir or meta-store. It may ease onboarding new users.

Contributor guide

Research direction
Locate where the default index root URI is initialized and add a warning with a link to documentation about filesystem limitations.
Tech stack
rust
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75