April 4, 2020 - Godocgen Launched

Article Details
Published DateFriday, April 4, 2020 GMT +0800
Reported By“Holloway” Chew, Kean Ho

On April 4, 2020 Malaysian Time, ZORALab Enterprise had launched a new open-source software product called Godocgen for Go Programmers (also known as Gophers). The goal was to help Gophers to generate Go package's documentations and host it with third-party website generator easily. This allows Gophers to process his/her software packages without overly relying on the main standard tools.

Godocgen

Development Motivations

The motivation originated from Holloway was very tired of waiting for some kind of miracles to happen when the initial Go doc web server feature was taken down due to the Go Module migration and requires upgrading efforts.

After various Go development, Holloway was very sick of issuing terminal command like “$ go doc -all .” every single time for simple tasks like referencing or cross-checking Go codes. Since the Go doc web server is unavailable and is one of the attractive feature in Go Programming Language, something needs to be done.

After exploring some static website generators like Hugo, Holloway found out that they really help to simplify and modularize software documentations easily in a software repository without primarily dependent on any third-party services. With that kind of freedom, it is very addictive to perform self-hosting for a software product.

The only gap left is to make generating and processing Go package modules’ documentations easily.

Starting Efforts

Godocgen prototype development was started from January 16, 2020 with the focus on re-create terminal output like go doc. On January 18, 2020, the re-creation was successfully executed and the first version: v0.0.1 was released on April 1, 2020 as a prototype.

Upgrading to Stable Product

After many interations of micro-upgrades and improvements, on April 16, 2020, the software went through its final unit-testing with 100% coverage and the first production version is released as v0.0.2. Then, it uses itself to produce its own website with documentations, making it ready to be released for public use.

Towards the Future

With Godocgen released to as a free and open-source license, it's time to upgrade it incrementally based on needs. After all, it's a free product for the benefits of all.

If you're interested to check out Godocgen, simply visit its official website at:

https://zoralab.gitlab.io/godocgen