quickwit-oss / quickwit-oss/quickwit
quickstart guide points to two non-existing documents
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Rust
- Stars
- 11.7k
- Forks
- 597
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 37
Description
The quickstart guide at https://github.com/quickwit-oss/quickwit/blob/main/docs/get-started/quickstart.md has two links at the end for Search on logs with timestamp pruning and Setup a distributed search on AWS S3 both of them do not exist (at least when I view inside the repository in the head)
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
Open docs/get-started/quickstart.md and inspect the two tutorial links at the end. Check whether the referenced tutorial paths exist in the repository, then correct the links or remove the broken entries as appropriate. Done means the quickstart no longer points to nonexistent documents.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100