Overview

My project focused on creating documentation for the technical onboarding guide for FLINT. This was targeted at helping new contributors to install FLINT with minimum support from the maintainers.

This documentation included all aspects of FLINT such as the FLINT, FLINT.docker and FLINT.example repository setup. Information on a FLINT based application GCBM has also been included as the next step for users to install after FLINT. Since previously FLINT documentation was not catered to all Operating Systems, the current documentation has been prompt at solving this problem. Screenshots have also been included wherever possible to keep the documentation as beginner-friendly as possible.

Deviations From Original Proposal

My original proposal focused on working with the FLINT documentation only. But after bonding with the team it became clear to expand the documentation to include more on GCBM and the moja global workflow.

After discussion, it was also decided to move all our documentation to readthedocs at a single place in a structured manner thus allowing the contributor to find a one-stop solution to any queries they may have. The domain can then be broken down into different routes for different sub projects under moja global.

Another addition to the original proposal was FAQs for installation support. After observing many folks facing different errors on their system, with their help and user research we were able to lay down some FAQs for installation support to help beginners refer to them in case they get stuck with the installations.

Project Deliverables

Contributors Website: This task involved creating a website that welcomes new contributors to moja global. It includes sections on how to begin contributing to moja global as well as beginner-friendly issues that are available. It also features contributors who have contributed recently.

Link to website: https://contributors-website.herokuapp.com/
Status of deliverable: Complete.

Restructuring and reorganization of the FLINT Documentation: The FLINT documentation wasn’t properly organised at a single place. So we refined and reorganised all the documentation into readthedocs. We also made sure to include installation procedures for the different Operating systems and screenshots wherever required to support them.

Links to guide: https://docs.moja.global/en/latest/FLINTDevelopmentSetup/index.html
Status of deliverables: Complete.

Adding GCBM Documentation: Prior to this the moja global repositories didn’t have any information on how to setup GCBM. So we added a section for the installation of GCBM after FLINT.

Link to guide: https://docs.moja.global/en/latest/GCBMDevelopmentSetup/index.html
Status of deliverable: Complete.

Including GitHub Guide: Since moja global is an environmental friendly organisation, we had different contributors pouring in from all over the world with some being not so skilled with GitHub. So we added specific git commands for fork, clone and even creating pull requests. The specific git branches to be considered were also given importance.

Link to guide: https://docs.moja.global/en/latest/DevelopmentSetup/git_and_github_guide.html
Status of deliverable: Complete

Lessons Learned

When working on any task, I realised the importance of creating issues by breaking down each deliverable into small parts and subsequent pull requests. It allowed me to remain connected with the team regarding the latest developments in my project and also allow them to give me feedback. We also had moved the docs to a publicly visible link and also auto-build pr specific links so mentors can exactly see the look and feel of the documentation and suggest changes.

Since we were a remote team, in order to remain connected we had regular meeting calls. We were also very clear about our availability beforehand. My mentors were really flexible in this manner and allowed me space to grow and learn as much as I can from this internship. I plan to continue working with this organisation for as long as it allows me.

Final Thoughts

Prior to this program I didn’t have a lot of technical writing experience, but I am confident now to understand what all technical writing entails. Apart from just documenting things, focus should be on making sure you have enough user research so that your documentation is simple enough to be understood for a wider audience. Working with an open source organisation in a remote team has again been a really fruitful experience. My mentors have been extremely helpful throughout the whole journey and I hope that I can keep contributing to Open Source more and more in the coming years.