GSOC Project: Versioning System for DISCOVER Cookbook

[aterrel]

I'm happy to announce that @AR21SM has been accepted as a student for GSOC. The proposal can be at #272.

We can keep this thread open for @AR21SM to post on the progress of the project.

[AR21SM]

Thank you so much, @aterrel . I’m incredibly grateful for this opportunity and excited to contribute to the project. 🙏

[AR21SM]

🗓️ Weekly Update – Community Bonding Week 1

This week, I focused on deepening my understanding of versioning systems and refining my proposal based on @aterrel feedback. I explored how versioning is implemented in projects like Spyder and scikit-learn, and began examining the associated tooling and workflows. I had a productive Google Meet discussion with @OriolAbril about internationalization in Sphinx and Jupyter Book, which clarified several key aspects of the translation process.

Summary of Activities

• I looked at how Spyder's documentation works, especially how they manage different versions and translations.
• Learned the basics of Git tags and began exploring how GitHub Actions can support automated version handling.
• Shared insights and architectural learnings in the internal discussion thread Architectural concerns over translations and archives #317 .
• Refined my proposal based on mentor feedback, clarifying the scope and approach for implementation.
• Had a meeting with Oriol to understand the translation process used in the Unconference 2023 Jupyter Book project.
• Discussed the key areas to focus on during the community bonding period.
• Studied the PyData Sphinx Theme version dropdown.

Current Learnings

scikit-learn integrates the PyData Sphinx Theme version dropdown and enhances it with a custom JavaScript (version-switcher.js) implementation to extend its capabilities and offer more version options.

Next Steps

Next, I plan to dive deeper into GitHub Actions , exploring CD setup of scikit-learn's .

---

I was unavailable during Community Bonding Weeks 2 & 3 due to college exams, so I wasn't able to contribute much during that time.

[aterrel]

Thanks for the post!

[AR21SM]

🗓️ Weekly Update: Week 1 & Week 2

• Added issue and PR templates under the .github directory

• Implemented dynamic version dropdown using versions.json

• Added static language switcher using languages.json

All changes can be reviewed in #330 and #328

Next Step:

• Begin exploring PR preview options using platforms like Netlify, Vercel, or CircleCI

[AR21SM]

🗓️ Weekly Update: Week 3 & Week 4

Completed Tasks

• Incorporated review feedback and made the necessary improvements in #330.
• Worked on fixing preview.yml to enable PR preview deployments.
  • Attempted fixes in #331 and #343, but it doesn’t currently support forked PRs.
• Created a discussion post to evaluate PR preview alternatives:
  • Choosing between Netlify or CircleCI
• Explored how to deploy different versions and languages in separate subfolders.

---

Next Steps

• As discussed in our last meeting, begin designing and implementing the Cookbook index page — a landing page to give users quick access to:
  • About section
  • Latest stable version (in multiple languages)
  • Development version (with contribution links)
• Start working on selected open issues.
• Set up Netlify on the repository for improved deployment and preview workflows.

[AR21SM]

🗓️ Weekly Update: Week 5 – Week 6

Week 5

Focus was on setting up Netlify PR previews and solving open issues in the repo.

• Stale PR Workflow: Added a workflow that marks pull requests as stale after 30 days with no activity. This keeps the repo clean and easier to manage. (See ci: add stale PR management workflow #347)
• Landing Page Design: Started work on the Cookbook landing page design.
• Netlify PR Previews: Configured Netlify to show preview builds for pull requests from forks. (See ci: enable Netlify deploy previews for PRs (forked) #349)

Week 6

Due to a personal commitment, no contributions were made this week.

---

🗓️ Weekly Update: Week 7 – Week 8

Week 7

Main focus was work on feedback, Content sorting, designing the landing page, and learning more about GitHub Actions.

• PR Feedback: Fixed maintainer feedback on PR feat: Implement dynamic version dropdown and static language switcher #330 to move it forward.
• Landing Page: Continued working on layout and content for the landing page.
• GitHub Actions: Explored GitHub Actions in detail, especially around deployment workflows.

Week 8

Work this week combined landing page improvements and deployment setup.

• Landing Page: Added theme switching (Light and Dark) and improved structure and content.
• GitHub Pages Deployment: Worked ont the deployment file so versions and languages are read automatically from JSON files.
• Auto Assign Workflow: Set up workflow to auto-assign issues. (See Automate issue assignment on pull requests #360)

---

🗓️ Weekly Update: Week 9 – Week 10

Week 9

This week focused on PR feedback, multilingual deployment, and mobile responsiveness of Landing Page.

• PR Feedback: Continued final work on PR feat: Implement dynamic version dropdown and static language switcher #330 based on review points.
• GitHub Pages: Worked on the deployment file, read documentation, and explored other codebases to understand multilingual and multiversion deployment better.
• Landing Page: Improved responsiveness across all devices for a smoother user experience.

Week 10

The week was spent polishing the landing page , Styling the switchers and fixing existing bugs in the workflows.

• Switchers Styling: Made both switchers consistent in style under PR feat: Implement dynamic version dropdown and static language switcher #330.
• Landing Page: Finalized the landing page design and solved responsiveness bugs.
• Workflows: Fixed bugs in GitHub workflows. (See Fix workflow bugs and enhance automation #372)

---

🗓️ Weekly Update: Week 11 – Week 12

Week 11

This week involved deployment fixes, Switchers styling updates, and automating issue claim Workflow.

• Landing Page PR: Opened PR Implement comprehensive landing page with responsive design and theme switching #373 with landing page changes and Switchers styling updates for both light and dark modes , Keyboard Navigation of Switchers-Styling .
• Deployment Workflows: Finalized workflows so deployment works correctly in subfolders, added redirects, and canonical URLs for versions.
• Auto Comment Bot: Created actions to auto-comment on issues and testing it on different different things like read issue number from commit message , read issue number from description and all , helping contributors claim issues easily (First PR to any Open issue). ( because auto-assign works only for collaborators and to github rules).

Week 12

The focus this week was on improving workflows, fixing some open issues, fixing deployment errors, and Version management Readme for maintainers .

• Workflows: PR for workflows to build multilanguage and multiversion correctly in subfolders (feat: matrix-parallelized multi-language CI/CD architecture with dynamic versioning #376) and fixed deployment errors (Add: max-parallel: 1 for language matrix jobs #387).
• Outdated Banner: Added an outdated version banner for version 1.0 and deployed 1.0 to GitHub Pages (feat: Add outdated version banner for 1.0-translations #380, Update repository and site URLs for 1.0 version #382).
• 2.0 Branch: Extended deployment setup and switcher styling to the 2.0 branch (Update workflows for 2.0-translations: Enable deployment and remove preview workflow #388, fix: add switcher styling to 2.0-translations and unknown version banner issue #390).
• Bug Fixes: Fixed index page issues, redirect links, switcher keyboard navigation bugs, and unknown version errors. Added detailed comments to the codebase for better readability (fix(ui): switcher styling bugs, mobile navigation, and unknown version banner issue #389).
• Dependabot: Set up Dependabot for dependency updates (python and github actions) (Add Dependabot configuration to keep GitHub Actions dependencies updated #378).
• Auto Comment: Finalized workflow testing and made pr for auto-comment on issue claims, so the first PR user can claim an issue (Fix workflow bugs and enhance automation #372).
• Markdown Links: Fixed the Markdown links checker workflow (open issue in repo) (Fix workflow bugs and enhance automation #372, Fix checklinks github action #81).
• I wrote comprehensive version release documentation for maintainers with step by step instructions. (docs: version release documentation with step-by-step instructions #393 )

[AR21SM]

@aterrel @OriolAbril @kamila-NF @emmasaroyan Weekly update (Week 5 – Week 12) :)

[AR21SM]

Hi @aterrel, @OriolAbril, @melissawm, @kamila-NF, and @emmasaroyan,

I'm happy to announce that my GSoC project is complete! The new versioned site is live at https://discover-cookbook.numfocus.org/

Thank you all so much for your incredible mentorship and for this fantastic opportunity!

[AR21SM]

Final Report

https://gist.github.com/AR21SM/f351a85dcc897c740a9f123bcd0a3972