GSoD Weekly Update: Week 0 & 1
## Week 0 :
* Set up personal blog. * Log progress for future reference. * Helpful for future Google Season of Docs applicants & participants. * Set up work-in-progress Github repository. * Created a work-in-progress documentation website, hosted at readthedocs using MkDocs static site generator. * One of the main reasons for the restructuring current doc website is due to cumbersome multiple yml config files for indexing purposes.
* Replacing the current complicated Jekyll + Cordova-doc-inspired workflow powered documentation with simple and powerful MkDocs static generator, which supports autoindexing done directly through the name of directory and/or the markdown rendered leading to a very simple single toml config file.
* Using the Read The Docs Theme helps to vastly simplify the doc hosting on Read The Docs platform. Because, this workflow supports searching, out-of-the box with use of the client side [lunar.js] search engine as a MkDocs plugin. * Multi-versioning support is also out-of-the box with the use of multiple branches which is then rendered individually in the Read The Docs interface. * Thus, this workflow follows Keep It Stupid Simple (KISS) philosophy, which would vastly help first timers, developers and the whole AGL community focus on the content of the documentation. ## Week 1 : * Renaming Directories * Started and partially completed with the very tedious task of manually renaming directories to properly index in The Read Docs platform. The changes are noticeable on the navigation side pane of before and after sites. * This renaming would need multiple iteration to finesse and once it is finalized on the master branch, similar renaming would be performed on other branches. Further relative internal links of images and other articles would have to be fixed. * Jan-Simon kindly initiated a gerrit repository over which the changes of github repository would be pushed for review, once renaming of the whole master-branch is complete.
Regards,
Shankho Boron Ghosh
Junior, Electronics & Communication Engineering
Thapar Institute of Engineering and Technology
+91 9819674639
_._,_._,_
Links:
You receive all messages sent to this group.
View/Reply Online (#8613) |
Reply To Group
| Reply To Sender
|
Mute This Topic
| New Topic
Your Subscription |
Contact Group Owner |
Unsubscribe
[list-automotive-discussions82@xxxxxxxxxxx]
_._,_._,_
