jenkinsci/jenkinsfile-runner

Create a new Docs page for Pipeline Verification

Open

#521 opened on Jun 10, 2021

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Java (291 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (1,090 stars)
PR merge metrics
 (Avg merge 47d 2h) (3 merged PRs in 30d)

Description

https://github.com/jenkinsci/jenkinsfile-runner/pull/511 by @pawoolley introduced support for a new lint command support for Jenkinsfile Runner. IMHO it is a new useful use-case for Jenkinsfile Runner users, and it deserves a documentation section in https://github.com/jenkinsci/jenkinsfile-runner/tree/master/docs/using

Acceptance criteria:

Contributor guide

Research direction
Read the linked PR https://github.com/jenkinsci/jenkinsfile runner/pull/511 and examine the existing documentation structure in https://github.com/jenkinsci/jenkinsfile runner/tree/master/docs/using. Create a new page following the same format, documenting the lint command usage and current Declarative Pipeline support.
Tech stack
None
Domain
backenddevops
Issue type
Documentation
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.
Under 1 hour
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
GitJenkins basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90