Outreachy Chronicles: Progress Report
What have we accomplished in the first half of the internship?
Time flies when you are busy, or when you are having fun, or when your world is crumbling. I cannot believe it has already been one and a half months since I began my JupyterHub Outreachy internship. We are already half-way, folks. What!? Just the other day I was making my application, submitting contributions, celebrating my acceptance, and now I can already see the end beckoning! Again, what! What?
FYI, initial applications for the next cohort of Outreachy internships are opening on January 16, 2023 and will run to February 6, 2023. If you are on Twitter or LinkedIn, follow the Outreachy accounts for updates. Or simply keep an eye on the Outreachy website (https://www.outreachy.org/).
Since we are half-way through the internship, what exactly have I accomplished? It is time to take stock of what I have been up to and whether I am earning my keep or simply, well, taking up space.
Recap: Project Goal
The main goal of the project on which I am working is to restructure JupyterHub’s existing documentation using the Diataxis framework.
As I covered in my last post,my work to accomplish this goal can be split into four main areas:
Performing a review of the present documentation.
Categorizing the documentation into the Diataxis framework.
Restructuring the documentation files in the repository.
Identify missing and unclear documentation.
Project Progress
So far, I have completed areas 1 and 2. I used the Google sheet here to, first, create a layout of the JupyterHub documentation (tab 1) and, second, map the docs into the four areas outlined in the Diataxis framework (tab 3). In tab 2, you can find notes I made while researching the Diataxis framework and examples of websites which I believe have implemented it successfully. Tab 4 (Mapping v.2) is the final mapping I will use to restructure the documentation files in the repository.
NOTES:
My mentor and I agreed to include a fifth section - FAQ - to ensure the findability of the questions within the website.
The process of creating documentation never ends. Similarly, the mapping above might not be perfect and is subject to change. If you find an issue, kindly leave a comment within the Google sheet.
SPECIAL NOTE:
So far, my work has been made incredibly easy because I have a wonderful mentor, Dr. Sarah Gibson, and a community that is willing to offer help and feedback.
What Next?
As the internship moves onto the second half, so does my work. Over the next three to four weeks, I will be restructuring the documentation in the JupyterHub Github repo as we proceed towards the project closeout.
Oh, how time moves fast when you are having fun!