vespa-engine/vespa

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

Open

#17,259 opened on Apr 2, 2021

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Java (4,948 stars) (561 forks)batch import
good first issue

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

Tech stack
rubyhtmlcss
Domain
documentation
Issue type
documentation
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Jekyll knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Investigate Jekyll plugins that can generate a single page HTML or PDF output (e.g., jekyll pdf, jekyll single page). Review the existing Jekyll configuration in the repository (likely in the docs directory) to understand the build process. Test a plugin locally and document the steps to integrate it. Check the comments in the issue for any previous suggestions or attempts.