Google Season of Docs 2019 Report¶
The Project Name was “Reference for Command Line Options in scancode-toolkit and Reorganize the structure of AboutCode documentation at aboutcode.readthedocs.io”
Restructured Documentation hosted at ReadTheDocs: Outdated Documentation from GitHub Wikis was updated, improved and converted to .RST, to be hosted at aboutcode.readthedocs.io.
Documentation Tests and Roadmaps: Documentation tests were added to check Documentation Builds, Internal/External Links, and Style Standards. These tests were added in both aboutcode and scancode-toolkit and already existing/new documentation was made compliant of these tests.
Command Line Options Referance: The entire Command Line Options were listed, explained, and their application elaborated from scratch. This is the main goal and the most important addition to the scancode-toolkit documentation.
Migration of Scancode-Toolkit docs into its own Repository: After adding the scancode toolkit docs to aboutcode and reviews, this section was migrated to its own repository, to be distributed with scancode-toolkit and with local builds enabled.
[WIP] Improve/Add to Existing Tutorials/How-Tos: Added two major Tutorials and other Tutorials/How-Tos were also updated to be consistent with the latest scancode versions and more Tutorials/How-Tos can be added later to better help the users.
[WIP] Add Plugin Support: A cookiecutter based plugin creation system has to be added, and relevant docs for this process and for the plugin architecture has to be added.
[WIP] Solve Other Documentation Issues: Solving multiple issues listed under the tag “Documentation”.
PRs before GSoD Started @ nexB/aboutcode¶
GSoD PRs @ nexB/scancode-toolkit¶
GSoD PRs @ nexB/aboutcode¶
[#26] Adds Documentation Versioning, Command Line Options, Changelog
[#27] CLI Options Reference for v3.1.1
[#29] Update Docs with changes in Wiki
[#30] Add doc8 style checks to Travis-CI
[#31] Fix template error
[#33] Add final Changes/Improvements before Migrating
[#34] Delete scancode-toolkit documentation
[#35] Add GSoD 2019 Report
I would like to thank Dennis Clark, Philippe Ombredanne and Steven Esser for their help throughout my GSoD project, from helping me prepare my proposal and project to constructive criticism, nit-picky reviews, conference calls to discuss project roadmaps and to explain to me when I was stuck in any problem. Their support and positivity helped me through this project and made me enjoy every bit of it.