vespa-engine/vespa

docs.vespa.ai as single-page html or pdf

Open

#17,259 opened on Apr 2, 2021

View on GitHubContributor guide
 (8 comments) (0 reactions) (0 assignees)Java (561 forks)batch import
good first issue

Repository metrics

Stars
 (4,948 stars)
PR merge metrics
 (PR metrics pending)

Description

... to make it easier to read Vespa documentation on an e-reader / offline

Vespa documentation is generated using Jekyll from .md and .html files, look into options for generating the artifact as part of site generation (there might be plugins we can use here)

Contributor guide

Research direction
Explore Jekyll plugins for generating single page HTML or PDF output and propose implementation.
Tech stack
None
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85