@@ -10,10 +10,10 @@ structure of AboutCode documentation at aboutcode.readthedocs.io"**
1010About Me
1111--------
1212
13- Name - Ayan Sinha Mahapatra
14- Email : ayansmahapatra@gmail.com
15- Country : India
16- Links :
13+ | Name - Ayan Sinha Mahapatra
14+ | Email : ayansmahapatra@gmail.com
15+ | Country : India
16+ | Links :
1717
1818- `Github <https://github.com/AyanSinhaMahapatra >`_
1919- `Twitter <https://twitter.com/ayansm23 >`_
@@ -28,15 +28,76 @@ Important Links for this GSoD Project
2828- `ScanCode Toolkit Docs <https://github.com/nexB/scancode-toolkit >`_
2929- `Aboutcode Docs <https://github.com/nexB/deltacode >`_
3030
31+ ----
3132
3233Project Overview
3334----------------
3435
35- The Project
36- -----------
36+ #. **Restructured Documentation hosted at ReadTheDocs: ** Outdated Documentation from GitHub Wikis
37+ was updated, improved and converted to .RST, to be hosted at aboutcode.readthedocs.io.
38+
39+ #. **Documentation Tests and Roadmaps: ** Documentation tests were added to check Documentation
40+ Builds, Internal/External Links, and Style Standards. These tests were added in both aboutcode
41+ and scancode-toolkit and already existing/new documentation was made compliant of these tests.
42+
43+ #. **Command Line Options Referance: ** The entire Command Line Options were listed, explained, and
44+ their application elaborated from scratch. This is the main goal and the most important addition
45+ to the scancode-toolkit documentation.
46+
47+ #. **Migration of Scancode-Toolkit docs into its own Repository: ** After adding the scancode toolkit
48+ docs to aboutcode and reviews, this section was migrated to its own repository, to be
49+ distributed with scancode-toolkit and with local builds enabled.
50+
51+ #. **[WIP] Improve/Add to Existing Tutorials/How-Tos: ** Added two major Tutorials and other
52+ Tutorials/How-Tos were also updated to be consistent with the latest scancode versions and more
53+ Tutorials/How-Tos can be added later to better help the users.
54+
55+ #. **[WIP] Add Plugin Support: ** A cookiecutter based plugin creation system has to be added, and
56+ relevant docs for this process and for the plugin architecture has to be added.
57+
58+ #. **[WIP] Solve Other Documentation Issues: ** Solving multiple issues listed under the tag
59+ "Documentation".
60+
61+ ----
3762
3863Pull Requests
3964-------------
4065
41- My Experience
42- -------------
66+ PRs before GSoD Started @ nexB/aboutcode
67+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
68+
69+ - `[#17] <https://github.com/nexB/aboutcode/pull/17 >`_ Adds Travis-CI for sphinx-build and linkcheck
70+ - `[#15] <https://github.com/nexB/aboutcode/pull/15 >`_ Adds Documentation from Wiki
71+ - `[#13] <https://github.com/nexB/aboutcode/pull/13 >`_ Adds GitHub wiki of Scancode-Toolkit and Scancode-Workbench
72+
73+ GSoD PRs @ nexB/scancode-toolkit
74+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
75+
76+ - `[#1784] <https://github.com/nexB/scancode-toolkit/pull/1784 >`_ Add Travis CI Test For Docs
77+ - `[#1827] <https://github.com/nexB/scancode-toolkit/pull/1827 >`_ Add New Issue and Pull Request Templates
78+ - `[#1812] <https://github.com/nexB/scancode-toolkit/pull/1812 >`_ Add Documentation from Aboutcode
79+ - [WIP] Add Cookiecutter Plugin and Plugin Docs
80+ - [WIP] `[#1847] <https://github.com/nexB/scancode-toolkit/pull/1847 >`_ Fix remaining documentation Issues
81+
82+ GSoD PRs @ nexB/aboutcode
83+ ^^^^^^^^^^^^^^^^^^^^^^^^^
84+
85+ - `[#26] <https://github.com/nexB/aboutcode/pull/26 >`_ Adds Documentation Versioning, Command Line Options, Changelog
86+ - `[#27] <https://github.com/nexB/aboutcode/pull/27 >`_ CLI Options Reference for v3.1.1
87+ - `[#29] <https://github.com/nexB/aboutcode/pull/29 >`_ Update Docs with changes in Wiki
88+ - `[#30] <https://github.com/nexB/aboutcode/pull/30 >`_ Add doc8 style checks to Travis-CI
89+ - `[#31] <https://github.com/nexB/aboutcode/pull/31 >`_ Fix template error
90+ - `[#33] <https://github.com/nexB/aboutcode/pull/33 >`_ Add final Changes/Improvements before Migrating
91+ - `[#34] <https://github.com/nexB/aboutcode/pull/34 >`_ Delete scancode-toolkit documentation
92+ - `[#35] <https://github.com/nexB/aboutcode/pull/35 >`_ Add GSoD 2019 Report
93+
94+ ----
95+
96+ Acknowledgments
97+ ---------------
98+
99+ I would like to thank `Dennis Clark <https://github.com/DennisClark >`_, `Philippe Ombredanne <https://github.com/pombredanne >`_ and `Steven Esser <https://github.com/majurg >`_
100+ for their help throughout my GSoD project, from helping me prepare my proposal and project to
101+ constructive criticism, nit-picky reviews, conference calls to discuss project roadmaps and to
102+ explain to me when I was stuck in any problem. Their support and positivity helped me through
103+ this project and made me enjoy every bit of it.
0 commit comments