Jenkins X project

This page contains the details of a technical writing project accepted for Season of Docs.

Project summary

Open source organization:
Jenkins X
Technical writer:
Nitin
Project name:
Refactoring the existing Jenkins X docs site and Jenkins X Capabilities Matrix
Project length:
Standard length (3 months)

Project description

The main objective of this project is to refactor the existing Jenkins X documentation whilst fixing the docs related issues as well as prepare the updated Jenkins X capabilities matrix along with the user documentation on Jenkins X usage on the enterprise cloud providers. In addition, this project also involves working on the development of Jenkins X preview environment infrastructure based on OpenShift, in collaboration with Daniel.

As part of refactoring the existing Jenkins X documentation, some of the issues that I would be working on, includes:

  • Boot in EKS Resources: Issue
  • Vault fails in EKS with Boot: Issue
  • Document envars for jx boot: Issue
  • Documentation needed for Vault setup: Issue
  • Boot upgrade from local to vault fails: Issue
  • Documentation Feedback Relationship of “create” vs “install jx” vs “boot” vs “import”: Issue
  • Helm Documentation is All over the place: Issue
  • Improve docs why ChartMuseum, Monocular and Docker Registry are not replaced with Nexus Issue
  • Unable to change Docker Registry when using Boot + GKE: Issue
  • Changing the domain from nip.io to a custom domain fails: Issue

For the Jenkins X capabilities Matrix, the work involves (as mentioned below) for enterprise Kubernetes services offered by each of the Cloud providers i.e., Google Cloud (GKE), Amazon Web Services (AWS EKS) and Azure Cloud (AKS).

  • Installation of Jenkins X on cloud via terraform scripts and jx boot
  • Checking about the compatibility of Kubernetes versions with Jenkins X on these cloud providers kubernetes services.
  • Any other Capability (Vault storage for secrets, Source control versions or others) to be discussed with Deane and the Jenkins X community members.

Regarding the work on the setting up of Jenkins X preview environment infrastructure based on OpenShift, the work includes:

  • Design document on Jenkins X preview environment infrastructure on OpenShift platform
  • Automate creation of Jenkins X preview environments in OpenShift
  • Update the documentation for Jenkins X on preview environments

Project Deliverables:

  • Fixes via PR to the above mentioned docs-issues, in consideration of refactoring the existing Jenkins X documentation.
  • Updated Jenkins X Capabilities Matrix along with the user documentation on using Jenkins X with different cloud providers (Kubernetes services mainly AKS, EKS and GKE).
  • Automated setting up of Jenkins X preview environment Infrastructure based on OpenShift, in collaboration with Daniel.

Tentative Timeline (along with tasks) proposed:

Community Bonding (Aug 17 - Sept 13)

  • Setup Development environment for technical documentation as well as gain access to Cloud infrastructures for working on the project tasks.
  • Discussion with the project mentors on the tentative timeline proposed, project deliverables as well as the tasks (along with their priority).
  • Understand and get well-equipped with the organization’s working process, PR review process, and get involved with the community.
  • Review Jenkins X current documentation state.

Week 1 (Sept 14 - Sept 20)

  • Understand the instructions for the setup of Jenkins X on cloud, current state and documentation.
  • Discussion with Deane, on the current Jenkins X capabilities (to be verified on different cloud providers).
  • Discussion with Daniel on the current state of Jenkins X preview environment infrastructure based on OpenShift.
  • Work (in collaboration with Daniel) to design architecture for Jenkins X preview environment infrastructure on OpenShift.

Week 2 (Sept 21 - Sept 27)

  • Work on the Jenkins X capability matrix for GKE cloud: installation of Jenkins X and preparing draft user notes.
  • Work on one of the docs-issue for improving the existing Jenkins X documentation.

Week 3 (Sept 28 - Oct 4)

  • Work on the Jenkins X capability matrix for GKE cloud: installation of Jenkins X and preparing draft user notes.
  • Work on one of the docs-issue for improving the existing Jenkins X documentation.
  • Work on the Design Document for Jenkins X preview environment infrastructure based on OpenShift.

Week 4 (Oct 5 - Oct 11)

  • Finalize the user docs for Jenkins X on GKE.
  • Work on one of the docs-issue for improving the existing Jenkins X documentation.

Week 5 (Oct 12 - Oct 18)

  • Work on the Jenkins X capability matrix for Azure cloud (AKS): installation of Jenkins X and preparing draft user notes.
  • Work on one of the docs-issue for improving the existing Jenkins X documentation.
  • Finalize the design document for Jenkins X preview environment infrastructure based on OpenShift, after getting feedback from the community members.

Week 6 (Oct 19 - Oct 25)

  • Work on the Jenkins X capability matrix for Azure cloud (AKS): installation of Jenkins X and preparing draft user notes.
  • Work on one of the docs-issue for improving the existing Jenkins X documentation.

Week 7 (Oct 26 - Nov 1)

  • Work on the Jenkins X capability matrix for Azure cloud (AKS): installation of Jenkins X and preparing draft user notes.
  • Work on one of the docs-issue for improving the existing Jenkins X documentation.
  • Work on Setting up of Jenkins X preview environment infrastructure based on OpenShift.

Week 8 (Nov 2 - Nov 8)

  • Finalize the user docs for Jenkins X on AKS.
  • Work on one of the docs-issue for improving the existing Jenkins X documentation.

Week 9 (Nov 9 - Nov 15)

  • Work on the Jenkins X capability matrix for AWS (EKS): installation of Jenkins X and preparing draft user notes.
  • Work on one of the docs-issue for improving the existing Jenkins X documentation.
  • Work on Setting up of Jenkins X preview environment infrastructure based on OpenShift.

Week 10 (Nov 16 - Nov 22)

  • Work on the Jenkins X capability matrix for AWS (EKS): installation of Jenkins X and preparing draft user notes.
  • Work on one of the docs-issue for improving the existing Jenkins X documentation.

Week 11 (Nov 23 - Nov 29)

  • Finalize the user docs for Jenkins X on EKS.
  • Work on one of the docs-issue for improving the existing Jenkins X documentation.
  • Finalize the documentation of Jenkins X preview environment infrastructure on the Jenkins X docs site.

Week 12 (Nov 30 - Dec 5)

  • Finalize the project deliverables and refactor the code if any, based on the feedback.
  • Test the working of the Jenkins X docs site including links, images, hyperlinks and others.
  • Check for the user-defined control and navigation of the Jenkins X docs site.
  • Check the finalized presentation of Jenkins X Capabilites matrix.

Before Dec 10, 2020 Both Technical Writer and Mentors submit evaluation of the project.

What benefits does the proposed project have for Jenkins X and its community? This project will help the Jenkins X community improve the documentation for its end-users as well as developers for reference on the Jenkins X technical architecture, compatibility, usage and integration. With the completion of this proposed project, there would then exist a full-fledged, well-defined and technically verified user documentation of Jenkins X along with the Jenkins X Capability Matrix for its compatibility with different cloud providers.

What future benefits do you plan to work on with Jenkins X? After the end of Google Season of Docs 2020 program, I’m planning to become a long-term contributor to the Jenkins X project as an active member of the community. I will always be around to help others (newcomers) and encourage them to get involved in the Jenkins X community. I would always be willing to work on other Jenkins X project ideas.

Some of the reasons which makes me best suited to work on this project:

  • I am very methodical and organized. I highly expect to keep informed about the progress of the project both to the project mentors and the organization community via blog posts once a week, scheduled SIG-docs weekly meetings and via emails on a regular basis.
  • Will be seeking guidance as well as feedback from the mentors and community members frequently, so as to progress with the tasks and ensuring everyone to be on the same page (inclusive mentioning of any challenges and/or blocking points faced).
  • Committing all the source code written on a regular basis, so as to get the code reviewed from the mentor, contributors and documenting the work done for reference to the community members.
  • I have all the desired technical skills required to work on this project idea and have discussed the project proposal with the mentors Deane, Kara and Daniel. I have got an in-depth understanding of the project proposal and it’s deliverables.
  • I have experience working with the technical skills (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo, and others) needed to provide a full fledged documentation as well as solve most of the current documentation related issues. I have the positive can do attitude who can get the project work done on time with little supervision.