Hi Jenkins developers, I’m Birajit Saikia, a GSoC 2025 contributor working with the Jenkins project on “Complete Build Retooling of jenkins.io”. The main goal of my project is to modernise and restructure Jenkins’ documentation ecosystem for better maintainability, usability, and performance.
To address this, the project aims to migrate non-versioned content to Gatsby and versioned documentation to Antora. The solution includes modernising the UI/UX with shared React components, integrating Algolia search, maintaining SEO-friendly redirects, and automating builds for smoother contributions. Key deliverables include a full content migration, unified responsive design with a Jenkins theme, cross-version navigation, and a CI/CD pipeline for seamless deployments. ------------------------------ What This Project Involves - Migrating versioned documentation to Antora - Creating a new Gatsby.js site for non-versioned content - Improving SEO metadata, link previews, and discoverability - Enhancing UI/UX for a more modern and accessible experience - Simplifying site build processes for contributors ------------------------------ What I’ve Done So Far (Community Bonding) Over the past few weeks, I’ve focused on laying a solid foundation for the work ahead: - Audited structural and content differences between jenkins.io and docs.jenkins.io (still a lot of auditing is left to be completed for gatsby part) - Started planning the migration using a folder-wise syncing strategy - Completed updates to three subfolders, implemented one small change PR with full updates, and submitted a pull request including the addition of images. - Set up a Notion tracker to manage tasks and cross-team coordination - Created a GitHub repo to publicly document progress, daily logs, and plans: https://github.com/biru-codeastromer/My-GSoC-Jenkins-2025 - Created the basic new gatsby site repository - We had our first weekly meet on 20th May ------------------------------ What I Plan to Do (Coding Period) As we move into the coding phase, my planned goals include: - Completing folder-wise syncing of content from jenkins.io to docs.jenkins.io - Building the base structure of the new Gatsby.js site - Establishing a clean separation between versioned (Antora) and non-versioned (Gatsby) content - Completing the non-versioned content migration to Gatsby - Setting up and testing Antora and Gatsby builds to ensure reliability - Adding essential SEO/meta tags and Open Graph enhancements - Implementing UI/UX improvements to modernize the documentation experience ------------------------------ How I’m Approaching It The overall strategy is to start small and iterate: - Begin with folders that have fewer changes to test the migration flow - Keep documentation and progress transparent via my GitHub repo and Notion tracker - Submit incremental pull requests for review and feedback from mentors and maintainers to the Gatsby site repository - Set up UI/UX and Gatsby-related issues in the docs.jenkins.io <https://github.com/jenkins-infra/docs.jenkins.io/issues> repo for tracking ------------------------------ Where I’d Appreciate Your Input As I prepare for the coding period, I’d really appreciate any feedback, ideas, or suggestions from the community to help improve the project further. If you’ve come across challenges while navigating Jenkins documentation or have thoughts on how the user or contributor experience could be improved, I’d love to hear from you. This could include: - Suggestions to improve content structure or navigation - Gaps in the documentation you think should be addressed - Feedback on design, usability, or accessibility - Any ideas to enhance the overall experience of our new tech stack website Please feel free to reply here or reach out directly ; your input would be invaluable in shaping this project in a direction that benefits the broader Jenkins community. I’d be happy to incorporate your feedback into the project plan. ------------------------------ Thanks to my mentors Kris Stern, Bruno Verachten, Kevin Martens, and Rajiv Singh for their consistent support throughout the bonding phase. Also a big thank-you to the Jenkins org admins for this opportunity. Looking forward to a productive and collaborative summer with you all! ------------------------------ Best regards, Birajit Saikia GSoC 2025 Contributor – Jenkins GitHub: @biru-codeastromer <https://github.com/biru-codeastromer>Gitter: @biru-codeastromer:gitter.im Discourse: <https://community.jenkins.io/u/birajit-saikia>@biru-codeastromer -- You received this message because you are subscribed to the Google Groups "Jenkins Developers" group. To unsubscribe from this group and stop receiving emails from it, send an email to jenkinsci-dev+unsubscr...@googlegroups.com. To view this discussion visit https://groups.google.com/d/msgid/jenkinsci-dev/CAGXhLarT_gJvVZka67mP3Rt5--rUyC_GJDZQNPKPcpfpXj5jsQ%40mail.gmail.com.
