Skip to content

Commit 3c8a9e7

Browse files
feat: update docs to latest version 2.504.x Part 7 (#309)
* WIP:feat - update docs to latest version 2.504.x Part 7 * fix conflicts * changes * added gsoc 2025 pages * updating * updating2 * updates3 * updates3 --------- Co-authored-by: Kris Stern <[email protected]>
1 parent dc47dee commit 3c8a9e7

32 files changed

+1137
-193
lines changed
346 KB
Loading

docs/projects/modules/ROOT/pages/index.adoc

Lines changed: 35 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,24 @@
11
= Jenkins Sub-projects
2-
3-
At the heart of the Jenkins project exists the automation engine's
4-
link:https://github.com/jenkinsci/jenkins[core] and hundreds of
5-
link:https://plugins.jenkins.io[plugins]. There are
6-
however other collaborative initiatives going on under the umbrella of the
7-
Jenkins project which grow or expand the project in new ways.
8-
9-
== Blue Ocean
10-
11-
image:images:ROOT:sunnyblueocean.png["Blue Ocean", width=128]
12-
13-
Blue Ocean is a project that rethinks the user experience of Jenkins, modelling
14-
and presenting the process of software delivery by surfacing information that's
15-
important to development teams with as few clicks as possible, while still
16-
staying true to the extensibility that Jenkins always has had as a core value.
17-
18-
19-
Blue Ocean also incorporates "The Jenkins Design Language (JDL)" which is a
20-
standardized set of components and a style guide that help developers create
21-
plugins which effortlessly retain the look and feel of the Blue Ocean user
22-
experience.
23-
24-
include::user-docs:blueocean:partial$blue-ocean-status.adoc[]
25-
26-
xref:user-docs:blueocean:getting-started.adoc[*Learn more*]
27-
282
---
293

30-
31-
== Document Jenkins on Kubernetes
32-
33-
image:images:ROOT:gsod/gsod.png["Google Season of Docs", width=128]
34-
35-
Kubernetes is a platform-agnostic container orchestration tool created
36-
by Google and heavily supported by the open-source community as a project
37-
of the Cloud Native Computing Foundation. Kubernetes is compatible with the
38-
majority of CI/CD tools which allow developers to run tests, deploy builds
39-
in Kubernetes and update applications with no downtime.
40-
41-
42-
Jenkins on Kubernetes is a popular theme for Jenkins users. There are a lot
43-
of presentations and articles about running Jenkins on Kubernetes, however,
44-
there's currently no central location for documentation describing Jenkins
45-
on Kubernetes. This project would create a new Kubernetes Volume which would
46-
describe the concepts, techniques, and choices for Kubernetes users running Jenkins.
47-
48-
49-
50-
xref:other:document-jenkins-on-kubernetes.adoc[*Learn more*]
4+
The Jenkins project includes Jenkins link:https://github.com/jenkinsci/jenkins[core] and over two thousand link:https://plugins.jenkins.io[plugins].
5+
There are other collaborative initiatives going on under the umbrella of the
6+
Jenkins project which grow or expand the project in new ways.
517

528
---
539

54-
5510
== Google Summer of Code
5611

5712
image:images:ROOT:gsoc/jenkins-gsoc-logo_small.png["Summer of Code", width=128]
5813

59-
The
60-
link:https://summerofcode.withgoogle.com/archive/[Google Summer of Code]
61-
(GSoC) project is an annual, international, program which encourages
62-
college-aged students to participate with open source projects during the summer
63-
break between classes. Students accepted into the program receive a stipend,
64-
paid by Google, to work well-defined projects to improve or enhance the Jenkins
65-
project. In exchange, numerous Jenkins community members volunteer as "mentors"
66-
for students to help integrate them into the open source community and succeed
67-
in completing their summer projects.
14+
The link:https://summerofcode.withgoogle.com/archive/[Google Summer of Code](GSoC) project is an annual, international, program which encourages college-aged students to participate with open source projects during the summer break between classes.
15+
Students accepted into the program receive a stipend, paid by Google, to work well-defined projects to improve or enhance the Jenkins project.
16+
In exchange, numerous Jenkins community members volunteer as "mentors" for students to help integrate them into the open source community and succeed in completing their summer projects.
6817

6918
xref:gsoc:index.adoc[*Learn more*]
7019

7120
---
7221

73-
7422
== Infrastructure
7523

7624
image:images:ROOT:network-workgroup.png["Infrastructure", width=128]
@@ -119,7 +67,6 @@ It is also used for the Remoting-based CLI and the {plugin}maven-plugin[Maven In
11967

12068
The Remoting sub-project includes the Remoting library itself, package for agents, and a number of Remoting-specific plugins and core modules.
12169

122-
12370
xref:remoting:index.adoc[*Learn more*]
12471

12572
---
@@ -151,3 +98,32 @@ Also, supports most of the public cloud providers (AWS, Azure, GCP) in terms of
15198
xref:jenkins-operator:index.adoc[*Learn more*]
15299

153100
---
101+
102+
== Kubernetes Documentation (done)
103+
104+
image:images:ROOT:gsod/gsod.png["Google Season of Docs", width=128]
105+
106+
Kubernetes is a popular platform for Jenkins.
107+
The Jenkins project uses Kubernetes to provide agents for ci.jenkins.io.
108+
Many Jenkins users install their controllers on Kubernetes.
109+
110+
The xref:user-docs:installing-jenkins:kubernetes.adoc[Kubernetes installation guide] provides detailed instructions for Jenkins on Kubernetes.
111+
A xref:sigs:docs:gsod/2020/projects/document-jenkins-on-kubernetes.adoc[Google Season of Docs project] created the Kubernetes installation guide.
112+
Maintenance of the Kubernetes installation guide is now provided by the xref:sigs:docs:index.adoc[documentation special interest group].
113+
114+
---
115+
116+
== Blue Ocean (archived)
117+
118+
image:images:ROOT:sunnyblueocean.png["Blue Ocean", width=128]
119+
120+
Blue Ocean was a project to improve the user experience of Jenkins, modelling
121+
and presenting the process of software delivery by surfacing information that's
122+
important to development teams with as few clicks as possible, while still
123+
staying true to the extensibility that Jenkins always has had as a core value.
124+
125+
include::user-docs:blueocean:partial$blue-ocean-status.adoc[]
126+
127+
xref:user-docs:blueocean:getting-started.adoc[*Learn more*]
128+
129+
---

docs/projects/modules/blueocean/pages/about.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
= About Blue Ocean
22

3+
34
.Elevator Pitch
45
""
56
Blue Ocean is a new user experience for Jenkins based on a personalizable,
@@ -38,10 +39,10 @@ Developers can make Jenkins their own by customizing their dashboard so that the
3839
""
3940
image:images:ROOT:blueocean/press/personalization.png[Personalized dashboard, role=center, width=100%]
4041

41-
.GitHub integration
42+
.Github integration
4243

4344
""
44-
Pipelines are run for all feature branches and pull requests, with their status reported back to GitHub, so the whole team knows if your changes need work or are good to go.
45+
Pipelines are run for all feature branches and pull requests, with their status reported back to Github, so the whole team knows if your changes need work or are good to go.
4546
""
4647
image:images:ROOT:blueocean/press/github-status.png[Github integration, role=center, width=100%]
4748

@@ -51,7 +52,6 @@ Also available for download in link:https://www.dropbox.com/s/1824kdeh0czdgna/Bl
5152
++++
5253
<center>
5354
<iframe width="853" height="480"
54-
style="max-width: 100%"
5555
src="https://www.youtube-nocookie.com/embed/k_fVlU1FwP4?rel=0" frameborder="0"
5656
allowfullscreen></iframe>
5757
</center>
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +0,0 @@
1-
:page-aliases: projects:gsoc/index.adoc
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
:page-aliases: projects:gsoc/index.adoc
Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
= GSoC 2025 Project Ideas
2+
3+
[.float-group]
4+
--
5+
image:images:ROOT:gsoc/jenkins-gsoc-logo_small.png[Jenkins GSoC, role=center, float=right,role=float-gap]
6+
This page aggregates project ideas for Google Summer of Code 2025. Refer to the xref:gsoc:index.adoc[Jenkins Google Summer of Code page] for more information about this project and applications.
7+
8+
Below you can find project ideas that have been proposed for this year. New ideas may be proposed by interested mentors or GSoC contributors, such as new features in the core or "write a plugin for MY_TOOL_OR_SERVICE". Project ideas without potential mentors will be considered, though applicants may need to work with the community and GSoC org admins to find mentors. To add a new project idea, see: xref:gsoc:proposing-project-ideas.adoc[proposing project ideas].
9+
--
10+
11+
== Accepted ideas
12+
13+
The following list contains the project ideas that fully match the Jenkins project idea standard. The scope of these ideas is understood and we don't normally expect deep changes. All ideas have quick-start guidelines and newbie-friendly issues referenced. We welcome contributors to join the mentor teams and invite GSoC contributors to submit project proposal applications related to these ideas.
14+
15+
[cols="3,1,1", options="header"]
16+
|===
17+
|Project |Category |Skills to study/improve
18+
19+
|*AI-Powered Chatbot for Quick Access to Jenkins Resources*
20+
Develop an AI-based chatbot to provide users with quick and intuitive access to Jenkins documentation, plugins, and community resources.
21+
22+
Potential Mentor(s):
23+
Vutukuri Sreenivas
24+
Kris Stern
25+
Ashutosh Singh
26+
|Plugins
27+
|Natural Language Processing (NLP), Python, JavaScript/TypeScript, Jenkins Plugin Development, Machine Learning
28+
29+
|*Backend code refactoring for Infra Statistics*
30+
To significantly refactor backend code for the Infra Statistics.
31+
32+
Potential Mentor(s):
33+
Kris Stern
34+
Bervianto Leo Pratama
35+
Phillipp Glanz
36+
|Infra
37+
|Groovy, Backend-frontend Integration, Code Refactoring, Infra / DevOps Processes
38+
39+
|*Complete build retooling of jenkins.io*
40+
Using alternative tooling with Gatsby and Antora to build the Jenkins static site and provide versioned Jenkins documentation.
41+
42+
Potential Mentor(s):
43+
Kris Stern
44+
Bruno Verachten
45+
Kevin Martens
46+
Rajiv Ranjan Singh
47+
|Tools
48+
|Web development, AsciiDoc, Static website tooling, Documentation, Website retooling
49+
50+
|*Domain-specific LLM based on actual Jenkins usage using ci.jenkins.io data*
51+
To develop a web app using an existing open-source LLM model with Jenkins usage data collected for domain-specific Jenkins knowledge to be fine-tuned.
52+
53+
Potential Mentor(s):
54+
Kris Stern
55+
Harsh Pratap Singh
56+
Shivay Lamba
57+
Vutukuri Sreenivas
58+
|Infra
59+
|Python, JavaScript/TypeScript, React.js, LLM, AI/ML, Jenkins, Ollama, LangChain, UI, Infra statistics, Data Analytics
60+
61+
|*Improving Tekton Client Plugin for Jenkins*
62+
Enhance the Jenkins Tekton Client Plugin to improve cloud-native CI/CD interoperability and user experience.
63+
64+
Potential Mentor(s):
65+
Vibhav Bobade
66+
Kris Stern
67+
|Plugins
68+
|Java, Kubernetes, Tekton, Jenkins
69+
70+
|*Improving Plugin Modernizer*
71+
Improving the Jenkins Plugin Modernizer tool and provide integrations with Jenkins ecosystem.
72+
73+
Potential Mentor(s):
74+
Bruno Verachten
75+
Valentin Delaye
76+
Sridhar Sivakumar
77+
Phillipp Glanz
78+
|Tools
79+
|OpenRewrite, Data structure (Trees) and visitor pattern, Java, Plugin hygiene and migration
80+
81+
|*Revamping jenkins.io website Success Stories feature*
82+
To revamp jenkins.io website's Success Stories feature to update both tooling and UI/UX experience with new design.
83+
84+
Potential Mentor(s):
85+
Kris Stern
86+
Bervianto Leo Pratama
87+
|UI/UX
88+
|Website development, UI/UX design, Geospatial data visualization, Gatsby.js and React.js
89+
90+
|*Swagger / OpenAPI standardization for Jenkins REST API*
91+
Standardizing Jenkins REST API documentation using Swagger or the OpenAPI specifications.
92+
93+
Potential Mentor(s):
94+
Kris Stern
95+
Bruno Verachten
96+
Rajiv Ranjan Singh
97+
Bervianto Leo Pratama
98+
Phillipp Glanz
99+
|Tools
100+
|Swagger / OpenAPI standardization, REST API, Documentation, Automation, Java
101+
|===
102+
103+
== Draft project ideas
104+
105+
In the following list, you can refer to draft project ideas, which are currently under review. The scope of such ideas may change during the discussions, but the idea is accepted in principle. You are welcome to comment on the draft and join the project as a mentor. If you are a GSoC contributor, it is also fine to explore and apply to the draft project ideas.
106+
107+
[cols="3,1,1", options="header"]
108+
|===
109+
|Project |Category |Skills to study/improve
110+
111+
|*Android and/or iOS tutorials in official documentation*
112+
Adding Android and/or iOS tutorials for Jenkins in the official documentation.
113+
114+
Potential Mentor(s):
115+
Bruno Verachten
116+
Kris Stern
117+
|Documentation
118+
|Documentation, Java, YAML, Android / iOS development, Command line tools
119+
120+
|*Pipeline documentation improvements - Phase 2 and Phase 3*
121+
Improving the navigation and implementation of the Pipeline Steps Reference.
122+
123+
Potential Mentor(s):
124+
Kris Stern
125+
Bervianto Leo Pratama
126+
|Documentation
127+
|Documentation, Web development, Jenkins plugins
128+
129+
|*Improving Jenkinsfile Runner abilities and GitHub Actions*
130+
To investigate the current state of the Jenkinsfile Runner project and to improve its abilities as well as those of GitHub Actions when used in conjunction.
131+
132+
Potential Mentor(s):
133+
Valentin Delaye
134+
Kris Stern
135+
Bervianto Leo Pratama
136+
|Tools
137+
|Java, Jenkinsfile Runner, Docker, GitHub Actions
138+
|===
139+
140+
== Ongoing discussion
141+
142+
These proposals are suggestions from the mailing list, which have not been published as project ideas yet. The feasibility is yet to be defined, and the idea may be dismissed depending on the feedback. Everyone is welcome to participate in the discussion and join as a potential mentor.
143+
144+
[cols="3,1", options="header"]
145+
|===
146+
|Project |Category
147+
148+
|*New Plugin for Jenkins Security Scanning*
149+
Exploring the feasibility of creating a security scanning plugin for Jenkins.
150+
151+
Potential Mentor(s):
152+
(Seeking mentors)
153+
|Security
154+
|===
Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
= AI-Powered Chatbot for Quick Access to Jenkins Resources
2+
3+
*Project goal:* Develop an AI-based chatbot to provide users with quick and intuitive access to Jenkins documentation, plugins, and community resources.
4+
5+
*Skills to study/improve:* Natural Language Processing (NLP), Python, JavaScript/TypeScript, Jenkins Plugin Development, Machine Learning
6+
7+
*Potential Mentors:*
8+
cnu1812
9+
krisstern
10+
ashu565
11+
12+
== Project Description
13+
14+
The aim is to create a Jenkins plugin that embeds a chatbot capable of understanding and responding to user inquiries about Jenkins. Leveraging Natural Language Processing (NLP) and Machine Learning (ML) techniques, the chatbot will interpret user questions and provide relevant information from official documentation, plugin repositories, and community forums.
15+
16+
== Benefits to the Community
17+
18+
- *Enhanced User Experience:* Users can obtain information quickly without leaving the Jenkins environment.
19+
- *Improved Accessibility:* Simplifies the learning curve for newcomers by providing instant answers to common questions.
20+
- *Increased Productivity:* Reduces the time spent searching for resources, allowing users to focus on development and deployment tasks.
21+
22+
== Comparable Solutions
23+
24+
While there are existing AI chatbots in various domains, an AI assistant tailored specifically for Jenkins is limited. A community discussion highlighted interest in developing a Jenkins Assistant plugin, indicating a demand for such a tool. This project aims to fill that gap by offering a specialized solution within the Jenkins ecosystem.
25+
26+
== Project Scope
27+
28+
- *Chatbot Development:* Implement NLP models to process and understand user queries related to Jenkins.
29+
- *Integration:* Develop a Jenkins plugin to host the chatbot, ensuring seamless interaction within the Jenkins user interface.
30+
- *Data Sources:* Configure the chatbot to access and retrieve information from Jenkins documentation, plugin directories, and community forums.
31+
- *User Interface:* Design an intuitive chat interface within Jenkins for user interactions.
32+
33+
== Quickstart
34+
35+
To get started:
36+
37+
1. *Familiarize Yourself with Jenkins Plugin Development:* Review the xref:developer:tutorial:index.adoc[Jenkins Plugin Tutorial].
38+
2. *Explore Relevant AI Libraries:* Investigate NLP frameworks such as https://www.nltk.org/[NLTK], https://spacy.io/[spaCy], https://pytorch.org/[PyTorch], https://docs.llamaindex.ai/en/stable/[LlamaIndex], etc., that can be integrated into Python applications.
39+
3. *Understand Existing Chatbot Implementations:* Study existing chatbot plugins or tools to gather insights into design and functionality.
40+
41+
== Links
42+
43+
* xref:developer:tutorial:index.adoc[Jenkins Plugin Tutorial]
44+
* https://nltk.org/[NLTK]
45+
* https://spacy.io/[spaCy]
46+
* https://pytorch.org/tutorials/beginner/chatbot_tutorial.html[PyTorch Chatbot Tutorial]
47+
48+
== Project Size
49+
175 - 350 Hours
50+
51+
== Project Difficulty Level
52+
Beginner to Intermediate
53+
54+
== Newbie-friendly Issues
55+
56+
Potential applicants can explore the following tasks to prepare:
57+
58+
- *Jenkins Plugin Development:* Start by creating a simple plugin to understand the basics of Jenkins plugin architecture.
59+
- *NLP Model Training:* Experiment with training NLP models on sample datasets to grasp the fundamentals of natural language understanding.
60+
- *Community Engagement:* Participate in Jenkins forums and Gitter channels to understand common user queries and challenges.
61+
62+
By undertaking these preliminary tasks, contributors can build a solid foundation for developing an AI-powered chatbot that enhances the Jenkins user experience.

0 commit comments

Comments
 (0)