Pipeline documentation improvements - Phase 2 and Phase 3

Project goal: Improving the navigation and implementation of the Pipeline Steps Reference

Skills to study/improve: Documentation, Web development, Jenkins plugins

NOTE: This idea is published as a draft under active discussion, but it is confirmed in principle. It is FINE to apply to it. The scope and the suggested implementation may change significantly before the final version is published. Sections like quickstart guide and newbie-friendly issues may be also missing. As a contributor, you are welcome to request additional information and to join the discussions using channels linked on this page.

Details

Background

Continuing from the GSoC 2022 Pipeline Step Documentation Generator project as Phase 2 of that project. More to do during this Phase 2 and the next Phase 3, as we will need to include both the refinement of the detailing and the navigation design. The project will involve the adopting of multiple plugins and improving their Pipeline Steps documentation. The selected contributor is expected to do lots of writing, exploring, testing, but not lots of coding.

Quick Start

Studying all materials relevant to the GSoC 2022 Pipeline Step Documentation Generator project and become familiar with them.

Skills to Study and Improve

  • Jenkins plugin development life cycle

  • Documentation

  • Web UI/UX design for documentation

  • Testing Jenkins plugins

Project Difficulty Level

Beginner to Intermediate

Project Size

175 to 350 hours (depending on the scope)

Potential Mentors

Project Links

Organization Links

> Go back to other GSoC 2025 project ideas