On 16th of September, I had a meeting with my mentors regarding my Google's Season Of Docs project.
The following tasks were assigned to me:-
Correcting the section order of the menu on the LHS of synbiohub.github.io
Provide correct links to the broken ones in the About SynBioHub and the references section.
Renaming the "Further References" section to the "References" section.
Moving the Plugins from the Installation section to the Plugins section and reconfiguring the table using Go-lang templates and partials provided by Hugo.
Changing the docker-installation to something more appropriate.
Include installation instructions for Mac OS and Linux OS to the installation section.
Remove all the content from the Source installation section and provide a link to the github repository.
Make a separate section for Setup and add some content to it, i.e. about Web-Of-Registries and SendGrid Mail setup.
Go through the doc on plugins sent by Jet.
Try and prepare a doc on Information collected from the assync. research paper that can be included in the documentation.
I was able to accomplish the following tasks:-
Provided correct links to the broken ones in the About SynBioHub section and the References section.
Renamed the "Further References" section to the "References" section.
Changed the docker installation to something more appropriate, though it still requires some improvement.
Included the installation instructions to Mac OS and Linux-Ubuntu 20.04 to the installation section.
Removed all the content from the Source installation section and gave the link to the github repo.
Installed SynBioHub without any error on Ubuntu.
Created a separate section for setup.
Added a brief description about "Web-Of-Registries" to the Setup section.
The Problems that I've encountered this week are:-
Couldn't re-order the menu. I tried to re-order the menu by allocating weight's to every section but surprisingly, it didn't do any good.
Though I was able to move the plugins table from the "Installation" section, but unfortunately I was unable to understand & use the Go-lang template and partials provided by Hugo. I've opened a few PR's on Hugo's repo and I'm hoping to find a feasible solution in the next couple of days.
Wanted to Upload a design to synbiohub.org but was unable to find the link to the repo from which I was to copy the designs.
Was unable to go through the doc sent by Jet fully. Though, I was able to go through the first few pages and had a few doubts.
Hope I'll be able to clarify the doubts that I have and plan tasks for the upcoming week in the next week.
Top comments (0)