Week 1 Blog June 18th, 2022

Published: 06/18/2022

Hello, my name is Claire Follett and I am a contributor under the DFFML Project, which is a project under the Python Foundation and is supported by GSOC. My proposal was to automate the documentation process, making documentation editing more intuitive and accessible.

What did you do this week?

This week was a very busy week for me, I finished my finals at Clatsop Community College and graduated yesterday. I still found time in between finals and graduation fun to work on this project. I was able to meet with my mentor a few days before GSOC officially began on June 13th, and we began setting up the work flow and working on our first objective, which was deploying our own static version of JupyterLite and figuring out how it works under the hood. Starting this week, I really focused on the "Upload File" button on the JupyterLite instance that we had running, and how it works, and how we could trigger the file upload mechanism. This took longer than I thought it would, and I spent a lot of my time in the code base, really looking at how they built the application and how it works. I wasn't able to spend as much time as I wanted to this week on GSOC stuff due to it being my finals week and graduation. But, I did put that in my proposal and I am now 100% free the rest of the 11 weeks to really dive into this project head first.

What is coming up next?

Continue the work from Week 1. Our original idea was to convert rst files to Jupyter Notebook format, but now we are focusing on this "Upload Files" button, and are trying to figure out if we could just use this button to load an instance where we could edit documentation and save it right there. 

Did you get stuck anywhere?

The biggest hurdles for me were the time constraints I had because I was wrapping up my associates degree, and also not spending all of my time going down a rabbit hole. I'm also not used to working on bigger projects and code bases this large before, so I definitely took a good amount of time this week familiarizing myself with how JupyterLite set up their code base and how it all works.