jetty/jetty.project

Document meaning of pemWorkDirectory

Open

#12795 opened on Feb 14, 2025

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (3,701 stars) (1,913 forks)batch import
DocumentationEnhancementHelp Wanted

Description

Jetty version(s) 12

Enhancement Description https://stackoverflow.com/a/77318094/14731 provides an excellent explanation of what ServerQuicConfiguration.pemWorkDirectory means and what it is used for. Please add a similar explanation to the ServerQuicConfiguration Javadoc.

Contributor guide

Tech stack
java
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.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaJavadocBasic SSL/TLS concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Read the StackOverflow answer at https://stackoverflow.com/a/77318094/14731 to understand pemWorkDirectory. Then locate the pemWorkDirectory field in ServerQuicConfiguration.java in the Jetty project codebase. Add Javadoc that explains its purpose and usage, following the existing Javadoc style in the file. Ensure the documentation references the same explanation.