Add GSoD 2021 Project Ideas List

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Author: AyanSinhaMahapatra

docs/source/gsod-toc.rst

@@ -11,6 +11,7 @@ More about of GSoD - <https://developers.google.com/season-of-docs>_
 .. toctree::
    :maxdepth: 2
 
+   gsod/gsod-2021
    gsod/gsod-2020
    gsod/gsod_2019_report
    gsod/gsod_2019

docs/source/gsod/gsod-2021.rst

@@ -0,0 +1,368 @@
+.. _GSoD2021:
+
+===================================
+:index:`Google Season of Docs 2021`
+===================================
+
+AboutCode.org is applying to be a mentoring organization for the `Google Season of Docs (GSoD) 2021 <https://developers.google.com/season-of-docs>`_.
+
+In the event that our proposal is accepted, we'll be looking for fellow members of the FOSS
+community with technical writing skills and an interest in helping.  If you're interested, keep
+reading to get a sense of what we have in mind for GSoD 2021.
+
+----
+
+.. contents:: Contents
+   :local:
+   :depth: 2
+
+----
+
+AboutCode Overview
+------------------
+
+AboutCode.org is a community of developers behind a suite of Software Composition Analysis tools
+(command line tools, web-based and API servers and desktop applications) and data for
+license, origin and security:
+
+* Where does the code come from?
+* What software packages are present?
+* What is its license? copyright?
+* Is the code secure, maintained, well coded?
+* Are there any known vulnerabilities?
+
+All these questions are important, and are relevant to millions of free and open source
+software components available on the web for reuse. The answers are critical to ensure that
+everyone can safely consume free and open source software.
+
+
+*Join us to make it so!*
+
+
+AboutCode Projects
+~~~~~~~~~~~~~~~~~~
+
+Our focus for GSoD 2021 is on `ScanCode Toolkit <https://github.com/nexB/scancode-toolkit>`_
+`ScanCode.io <https://github.com/nexB/scancode.io>`_, and
+`Scancode Workbench <https://github.com/nexB/scancode-workbench>`_, but proposals to
+improve the documentation for other AboutCode projects are welcome.
+
+See :ref:`aboutcode-project-overview` for a complete list of AboutCode projects.
+
+Technology
+~~~~~~~~~~
+
+We primarily use Python for AboutCode software. There is also some code in C/C++ or other
+languages. We use Electron/JavaScript for the ScanCode Workbench desktop application.
+Scancode.io is based on Django and JavaScript.
+
+Our domain includes text analysis and processing (e.g., for copyright and license
+detection), parsing (for package manifest formats), binary analysis (to detect the origin and
+license of binaries), web-based tools and APIs (to expose the tools and libraries as web
+services) and low-level data structures for efficient matching (such as Aho-Corasick and
+other automata).
+
+For documentation we primarily use reStructured Text files with Sphinx and ReadTheDocs.
+
+
+Contact Info
+~~~~~~~~~~~~
+
+Join the chat online or by IRC at https://gitter.im/aboutcode-org/gsod-season-of-docs.
+Introduce yourself and start the discussion!
+
+You can also contact:
+
+- the primary org admin directly: @pombredanne and pombredanne@gmail.com
+- the GSoD coordinator directly: jmhoran@nexb.com
+
+Technical Writing Skills Needed
+-------------------------------
+
+Incoming technical writers will need the following skills:
+
+- Ability to install and configure open source code from GitHub.
+- Ability to understand and run programs from the command line in a terminal window.
+- An interest in FOSS licensing and software code and origin analysis.
+- Ability to pick up working knowledge of our tools with mentor guidance.
+
+During the application process and during a GSoD project with us you will learn how to:
+
+- Design and create documentation as Tutorials, HowTo Guides, Reference or Discussions.
+- Optionally, creating video socumentation guides for tools and UI.
+- Create and edit documentation files in reStructured Text.
+- Manage documentation files with Sphinx.
+- Publish documentation to ReadTheDocs.
+
+We are happy to help you get up to speed. The more you are able to demonstrate ability and
+skills in advance, the more likely we are to choose your application!
+
+About Your Project Application
+------------------------------
+
+Check out the `GSoD Tech Writer Guide <https://developers.google.com/season-of-docs/docs/tech-writer-guide>`_
+ and `Statement Template <https://developers.google.com/season-of-docs/docs/tech-writer-statement>`_.
+
+Your statement of interest should be in the range of 1,000 words,
+and should contain the following information, plus anything else that
+you think is relevant:
+
+- Personal information, i.e. Your name and contact details.
+
+- A Project statement.
+
+- A detailed description of your idea including an explanation of what
+  it will contribute to the project.
+
+- Description of your relevant skills.
+
+- Professional information: Description of previous work, existing solutions,
+  open-source projects, preferably with links.
+
+- Proposed Timeline
+
+- Proposed budget or hourly rate
+
+- Do you plan to have any other commitments during GSoD that may affect your work? Any
+  vacations/holidays? Will you be available full time to work on your project? Please apply
+  only if this is a serious full time commitment during the GSoD time frame.
+
+Join the chat online or by IRC at https://gitter.im/aboutcode-org/gsod-season-of-docs.
+Introduce yourself and start a discussion!
+
+An excellent, competitive way to demonstrate your capability would be to submit a documentation
+improvement (small changes/typos are welcome but doesn't demostrate your ability) to an AboutCode
+project, especially to ScanCode Toolkit, Scancode.io and ScanCode Workbench.
+
+You can pick a project idea from the list below. You can also submit
+`Your Documentation Project Ideas <#your-documentation-project-ideas-2021>`_.
+
+Our Documentation Project Ideas
+-------------------------------
+
+Note that the AboutCode focus for GSoD 2021 is on ScanCode Toolkit, Scancode.io and ScanCode
+Workbench, although proposals to improve the documentation for other AboutCode projects are welcome.
+
+`Your Documentation Project Ideas <#your-documentation-project-ideas-2021>`_ are welcome too! Please
+chat about them to increase your chances of success!
+
+----
+
+Docs to Integrate third-party libraries in scancode.io pipelines
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~-------------------
+
+* Create documentation on integrating third-party libraries in a scancode.io pipeline step.
+* Add a simple tutorial example of adding a new pipeline with a third-party library.
+
+Note: Filter current Scancode.io GitHub Issues by Label 'documentation' to see many examples of
+specific areas for improvement.
+
+- **Level**
+
+  - Intermediate
+
+- **Tech**
+
+  - Command line processing in a Linux-compatible terminal window
+  - Python [Django]
+  - GitHub, reStructured Text and Sphinx
+
+- **URLs**
+
+  - https://scancodeio.readthedocs.io
+  - https://github.com/nexB/scancode.io
+  - https://gitter.im/aboutcode-org/discuss
+
+- **Mentors**
+
+  - https://github.com/johnmhoran
+  - https://github.com/mjherzog
+  - https://github.com/tdruez
+
+
+Improve scancode.io Documentation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Upgrade the scancode.io documentation on ReadTheDocs by streamlining and re-organizing it.
+* Upgrade the scancode.io documentation on creating projects and running pipelines.
+* Upgrade the scancode.io documentation on making sense of the results using the UI.
+* Apply the Tutorial, HowTo, Reference and Discussions framework.
+* An alternative could be creating `videos explaining the UI <https://opensource.com/article/21/3/video-open-source-tools>`_
+* Implement process to sync documentation changes with releases.
+
+Note: Filter current Scancode.io GitHub Issues by Label 'documentation' to see many examples of
+specific areas for improvement.
+
+- **Level**
+
+  - Intermediate
+
+- **Tech**
+
+  - Command line processing in a Linux-compatible terminal window
+  - Python [Django]
+  - GitHub, reStructured Text and Sphinx
+
+- **URLs**
+
+  - https://scancodeio.readthedocs.io
+  - https://github.com/nexB/scancode-io
+  - https://gitter.im/aboutcode-org/discuss
+
+- **Mentors**
+
+  - https://github.com/johnmhoran
+  - https://github.com/mjherzog
+  - https://github.com/tdruez
+
+
+Improve ScanCode-Toolkit Plugin Documentation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* Explain the Plugin Architechture used in scancode-toolkit
+* Explain the types of plugins used in scancode-toolkit
+  (pre-installed/seperately-installed) and (post-scan, pre-scan, scanner)
+* An exhaustive list of all plugins and what they do, with links to their code.
+
+Note: Filter current scancode-toolkit GitHub Issues by Label 'documentation' to see
+many examples of specific areas for improvement.
+
+- **Level**
+
+  - Intermediate
+
+- **Tech**
+
+  - Command line processing in a Linux-compatible terminal window
+  - GUI design
+  - GitHub, reStructured Text and Sphinx
+
+- **URLs**
+
+  - https://scancode-toolkit.readthedocs.io
+  - https://github.com/nexB/scancode-toolkit
+  - https://gitter.im/aboutcode-org/scancode
+
+- **Mentors**
+
+  - https://github.com/johnmhoran
+  - https://github.com/majurg
+  - https://github.com/AyanSinhaMahapatra
+
+
+Documentation to create ScanCode-Toolkit Plugins
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* How to create a minimal plugin adding some functionality to scancode-toolkit.
+* Useful examples of different types of plugins
+* Using `nexb/skeleton <https://github.com/nexB/skeleton>`_ as a template for plugins.
+
+Note: Filter current scancode-toolkit GitHub Issues by Label 'documentation' to see
+many examples of specific areas for improvement.
+
+- **Level**
+
+  - Intermediate
+
+- **Tech**
+
+  - Command line processing in a Linux-compatible terminal window
+  - GUI design
+  - GitHub, reStructured Text and Sphinx
+
+- **URLs**
+
+  - https://scancode-toolkit.readthedocs.io
+  - https://github.com/nexB/scancode-toolkit
+  - https://gitter.im/aboutcode-org/scancode
+
+- **Mentors**
+
+  - https://github.com/johnmhoran
+  - https://github.com/majurg
+  - https://github.com/AyanSinhaMahapatra
+
+
+Automated Documentation generation on Scancode Data
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The goal of this project is to create a documentation section automatically for all
+scancode data attributes.
+
+There is currently no single file in the codebase (like Django models), but there are
+several of them present throughout the codebase.
+
+* A first step should be to investigate whether there are existing automated documentation
+  tools for Python that would help us get started.
+
+* Use attrs classes all the way for models and define/design a simple way to add a
+  docstring/attribute of sorts to each model and attribute.
+
+* Make a list of all data attributes to document (that appears in the scancode result)
+  and implement the above for all of them.
+
+* Have/create a way to get that integrated into sphinx, possibly with custom extensions.
+
+* Integrate with existing doc generation, and make it a part of doc publication, with
+  docs to help contributors keep the data documentation updated.
+
+It should be hosted as a section in the scancode RTD documentation::
+
+  `scancode-toolkit.readthedocs.io/en/latest/scancode-data/`
+
+You will work closely with a mentor to add the documentation and implement the automatic
+documentation creation process.
+
+- **Level**
+
+  - Advanced
+
+- **Tech**
+
+  - Command line processing in a Linux-compatible terminal window
+  - Python programming
+  - GitHub, reStructured Text and Sphinx
+
+- **URLs**
+
+  - https://github.com/nexB/scancode-toolkit/issues/2008
+  - https://scancode-toolkit.readthedocs.io/en/latest/index.html
+  - https://github.com/nexB/scancode-toolkit
+  - https://gitter.im/aboutcode-org/scancode
+
+- **Mentors**
+
+  - https://github.com/johnmhoran
+  - https://github.com/majurg
+  - https://github.com/AyanSinhaMahapatra
+
+----
+
+.. _your_documentation_project_ideas-2021:
+
+Your Documentation Project Ideas
+--------------------------------
+
+Download and install `ScanCode Toolkit <https://github.com/nexB/scancode-toolkit>`_,
+`ScanCode.io <https://github.com/nexB/scancode.io>`_, and
+`Scancode Workbench <https://github.com/nexB/scancode-workbench>`_ and try them out.
+For example, you may try scanning an open source software package in a technology
+with which you are familiar. What are the documentation weak points?
+
+
+* Is it difficult to get started? A **Tutorial** documentation opportunity.
+* Is it difficult to accomplish a specific objective? A **How-To** documentation opportunity.
+* Are the capabilities of the tool too mysterious? Do you want to know more about what you can do
+  with it? A **Reference** documentation opportunity.
+* Do you feel that you need to understand its concepts better in order to use it and trust it? Do
+  you want to know more about how the code scanning actually works? A **Discussion** documentation
+  opportunity.
+
+Feel free to propose and describe your own documentation ideas.
+Mentoring
+---------
+
+We welcome new mentors to help with the program. We require some understanding of the project
+domain to join as a mentor.
+
+Contact the team on Gitter at https://gitter.im/aboutcode-org/gsod-season-of-docs