DEV Community

Cover image for Season Of Docs, Meeting-5
Prubhtej Singh
Prubhtej Singh

Posted on

Season Of Docs, Meeting-5

On 23rd of September, I had a weekly meeting with regards to my Google's Season Of Docs project. The mentor's had assigned the following tasks :

  1. Finish reading the Plugins Docs and include Plugins doc into the main docs.
  2. Sending the Google doc containing relevant info from ACS research paper.
  3. Solving the Table of contents issue.
  4. Completing the implementation of API using the UI of SynBioHub.
  5. Completing the setup page.
  6. Include the link of the plugins table rather than the whole table on the plugins page.

I was able to accomplish the following tasks:

  1. Extracted out relevant info from the ACS research paper, though it was too much. Hence, on the advise of Prof. Myers I'm trying to reduce the content to 1 paragraph at max containing info. about Plugins ans Web-Of-Registries.
  2. Solved the table of contents issues, thanks to My mentor and developer of ACE-documentation theme.
  3. Included the link of plugins table in the documentation that has already been implemented, hence removing the whole table from the docs, which was not looking up to the mark.
  4. I'm almost done including the Plugins doc into the Plugins section of the documentation. A little bit of formatting and editing is left to be done.
  5. I was able to execute almost all the API's using the UI of SynBioHub.

Following are the issues that I'd faced this week:

  1. Extracted out too much of information from the ACS research paper, hence on the advice of Prof. Myers, I've substantially reduced the content and plan to reduce it further.
  2. I haven't used Sendgrid before, hence it was kind of a challenge for me to learn about it's nuances, but still I was able to complete the Setup page well on time.
  3. I'm still encountering some challenges on running locally onto Ubuntu. Hence, I tried to run it on a Mac, on which it successfully ran without any glitches. I tried to do a bit of research, according to which I need to install docker again onto my PC.
  4. The doc that Jet had sent contained a lot of information on plugins. I do have some doubts and I'll try to clarify them in the meeting.

I was able to complete almost all the tasks, this week well in time. Hope to discuss the upcoming tasks in the next meeting i.e. on 30th September!

Top comments (0)