Skip to content

Commit cabb3ea

Browse files
AyanSinhaMahapatraAyanSinhaMahapatra
committed
Add GSoD 2021 Project Ideas List
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent d032397 commit cabb3ea

2 files changed

Lines changed: 233 additions & 0 deletions

File tree

‎docs/source/gsod-toc.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ More about of GSoD - <https://developers.google.com/season-of-docs>_
1111
.. toctree::
1212
:maxdepth: 2
1313

14+
gsod/gsod-2021
1415
gsod/gsod-2020
1516
gsod/gsod_2019_report
1617
gsod/gsod_2019

‎docs/source/gsod/gsod-2021.rst‎

Lines changed: 232 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,232 @@
1+
.. _GSoD2021:
2+
3+
===================================
4+
:index:`Google Season of Docs 2021`
5+
===================================
6+
7+
AboutCode.org is applying to be a mentoring organization for the `Google Season of Docs (GSoD) 2021 <https://developers.google.com/season-of-docs>`_.
8+
9+
In the event that our proposal is accepted, we'll be looking for fellow members of the FOSS
10+
community with technical writing skills and an interest in helping. If you're interested, keep
11+
reading to get a sense of what we have in mind for GSoD 2021.
12+
13+
----
14+
15+
.. contents:: Contents
16+
:local:
17+
:depth: 2
18+
19+
----
20+
21+
AboutCode Overview
22+
------------------
23+
24+
AboutCode.org is a community of developers behind a suite of Software Composition Analysis tools
25+
(command line tools, web-based and API servers and desktop applications) and data for
26+
license, origin and security:
27+
28+
* Where does the code come from?
29+
* What software packages are present?
30+
* What is its license? copyright?
31+
* Is the code secure, maintained, well coded?
32+
* Are there any known vulnerabilities?
33+
34+
All these questions are important, and are relevant to millions of free and open source
35+
software components available on the web for reuse. The answers are critical to ensure that
36+
everyone can safely consume free and open source software.
37+
38+
39+
*Join us to make it so!*
40+
41+
42+
AboutCode Projects
43+
~~~~~~~~~~~~~~~~~~
44+
45+
Our focus for GSoD 2021 is to improve documentation on our flagship projects:
46+
47+
- `ScanCode Toolkit <https://github.com/nexB/scancode-toolkit>`_
48+
- `ScanCode.io <https://github.com/nexB/scancode.io>`_
49+
- `Vulnerablecode <https://github.com/nexB/scancode-workbench>`_
50+
51+
And specifically to create/update developement and user guides.
52+
53+
See :ref:`aboutcode-project-overview` for a complete list of AboutCode projects.
54+
55+
56+
Technology
57+
~~~~~~~~~~
58+
59+
We use Python for programming AboutCode software. Our projects are a combination of
60+
command line tools, libraries, and web based applications based on Django and JavaScript.
61+
62+
Our command line tools are designed to run on Linux, macOS and Windows, and
63+
our web-based applications run only on Linux.
64+
65+
We write our documentation using reStructuredText with Sphinx and ReadTheDocs.
66+
67+
We use git and GitHub to store our code and track tasks and issues.
68+
69+
70+
Technical Skills Needed
71+
-----------------------
72+
73+
Incoming technical writers will need the following skills:
74+
75+
- Basic understanding of reStructuredText, Sphinx and ReadTheDocs-based documentation
76+
toolchain including git.
77+
- Ability to understand and run programs from the command line in a terminal.
78+
- Ability to read well-structured Python code, and to update Python docstrings.
79+
- Ability to manage Windows and Linux based installation of our tools if need be in
80+
virtual machines.
81+
- Ability to write technical documentation such as Tutorials, How-To Guides, and
82+
API References.
83+
84+
We do not expect a working knowledge of our tools as this will be picked from mentors and
85+
community guidance. An interest in FOSS licensing and software code and origin
86+
analysis would be welcome but is not a hard requirement.
87+
88+
Some of these skills could be picked up during the project with help from your mentors, for
89+
candidates with strong writing skills.
90+
91+
92+
About Your Project Application
93+
------------------------------
94+
95+
Check out the `GSoD Tech Writer Guide <https://developers.google.com/season-of-docs/docs/tech-writer-guide>`_
96+
and `Statement Template <https://developers.google.com/season-of-docs/docs/tech-writer-statement>`_.
97+
98+
Your statement of interest should be in the range of 1,000 words,
99+
and should contain the following information, plus anything else that
100+
you think is relevant:
101+
102+
- Personal information, i.e. Your name and contact details.
103+
104+
- A Project statement.
105+
106+
- A detailed description of your project.
107+
108+
- Description of your relevant skills.
109+
110+
- Professional information: Description of previous work, existing solutions,
111+
open-source projects, preferably with links.
112+
113+
- Proposed Timeline
114+
115+
- Proposed total budget
116+
117+
- Do you plan to have any other commitments during GSoD that may affect your work? Any
118+
vacations/holidays? Will you be available full time to work on your project? Please apply
119+
only if this is a serious full time commitment during the GSoD time frame.
120+
121+
Join the chat online or by IRC at https://gitter.im/aboutcode-org/gsod-season-of-docs.
122+
Introduce yourself and start a discussion!
123+
124+
An excellent, competitive way to demonstrate your capability would be to submit a documentation
125+
improvement (small changes/typos are welcome but do not demonstrate your ability to write
126+
documentation) to an AboutCode project, especially to ScanCode Toolkit, Scancode.io.
127+
128+
Please select a project from the list below.
129+
130+
----
131+
132+
Create and update scancode.io user and developer guides
133+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134+
135+
* Create documentation on integrating third-party libraries in a scancode.io pipeline step.
136+
* Add a simple tutorial example of adding a new pipeline with a third-party library.
137+
* Update and extend the user guide for code analysis project creation and processing.
138+
* Upgrade the scancode.io documentation on making sense of the results using the UI.
139+
* Create an introductory `video <https://opensource.com/article/21/3/video-open-source-tools>`_
140+
to teach how the web UI is used.
141+
* Create and generate pipes reference API documentation.
142+
143+
- **Level**
144+
145+
- Intermediate
146+
147+
- **Tech**
148+
149+
- Command line processing in a Linux-compatible terminal window
150+
- Python [Django]
151+
- GitHub, reStructured Text and Sphinx
152+
153+
- **URLs**
154+
155+
- https://scancodeio.readthedocs.io
156+
- https://github.com/nexB/scancode-io
157+
- https://gitter.im/aboutcode-org/discuss
158+
159+
- **Mentors**
160+
161+
- https://github.com/johnmhoran
162+
- https://github.com/mjherzog
163+
- https://github.com/tdruez
164+
- https://github.com/AyanSinhaMahapatra
165+
166+
167+
Create ScanCode-Toolkit Plugin Author Guide
168+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
169+
170+
The goal of this guide is to provide an end-to-end tutorial and instruction
171+
set on how to create scancode-toolkit plugins, with concrete examples and to
172+
generate a reference API documentation for modules, classes and functions used to
173+
create plugins.
174+
175+
Some of the specific supported activities would be:
176+
177+
* Explain the Plugin Architechture used in scancode-toolkit
178+
* Explain the types of plugins used in scancode-toolkit
179+
(pre-installed/seperately-installed) and (post-scan, pre-scan, scanner)
180+
* An exhaustive list of all plugins and what they do, with links to their code.
181+
* How to create a minimal plugin adding some functionality to scancode-toolkit.
182+
* Useful examples of different types of plugins
183+
* Using `nexb/skeleton <https://github.com/nexB/skeleton>`_ as a template for plugins.
184+
185+
Note: Filter current scancode-toolkit GitHub Issues by Label 'documentation' to see
186+
many examples of specific areas for improvement.
187+
188+
- **Level**
189+
190+
- Intermediate
191+
192+
- **Tech**
193+
194+
- Some lightweight python programming to create example plugins and
195+
understand how they are constructed, the mentors will help here.
196+
- Command line processing in a Linux-compatible terminal window
197+
- GitHub, reStructured Text and Sphinx
198+
199+
- **URLs**
200+
201+
- https://scancode-toolkit.readthedocs.io
202+
- https://github.com/nexB/scancode-toolkit
203+
- https://gitter.im/aboutcode-org/scancode
204+
205+
- **Mentors**
206+
207+
- https://github.com/johnmhoran
208+
- https://github.com/majurg
209+
- https://github.com/AyanSinhaMahapatra
210+
211+
212+
----
213+
214+
Mentoring
215+
---------
216+
217+
We have an established team of contributors that are willing to mentor the selected
218+
Tech Writers, and they have extensive experience from mentoring in the open, including
219+
a successful previous participation in Google Season of Docs 2019. We have a developed
220+
a gentle and efficient way to mentor our contributors to success.
221+
222+
223+
Contact Info
224+
~~~~~~~~~~~~
225+
226+
Join the chat online or by IRC at https://gitter.im/aboutcode-org/gsod-season-of-docs.
227+
Introduce yourself and start the discussion!
228+
229+
You can also contact:
230+
231+
- the primary org admin directly: @pombredanne and pombredanne@gmail.com
232+
- the GSoD coordinator directly: jmhoran@nexb.com

0 commit comments

Comments
 (0)