You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@beam.apache.org by Roopal Jain <ro...@gmail.com> on 2020/05/16 03:32:47 UTC

Interested In Google Season of Docs!

I am interested in participating in Google Season of Docs for Apache Beam.
I went through the proposal and thought this is something I could do well.
I am currently working as a software engineer and have a B.E in Computer
Engineering from one of India's reputed engineering colleges. I have prior
open-source contribution with mentoring for Google Summer of Code and
Google Code-In.
I have prior work experience on Apache Spark and a good grasp on SQL, Java,
and Python.
I have basic knowledge of GCP. It was mentioned in the doc the new features are
accessible for Beam contributors, but they are not available in the
user-facing documentation. I might be able to understand designs and
features well and as a describe them in layman terms to someone who is
looking forward to contribute or adapt to a new tech stack.

Please guide me more on how to get started?

Thanks & Regards,
Roopal Jain

Re: Interested In Google Season of Docs!

Posted by Pablo Estrada <pa...@google.com>.
Hello Roopal!

Thank you for the introduction and your interest to work on Apache Beam
documentation with Season of Docs. To participate in the program you need
to follow the guides here [1] [2]. If you are new to the program, we
suggest:

   1.

   Start by studying our proposed project ideas and expected deliverables
   for each of them [3].
   2.

   Explore more in depth the existing related Beam documentation for each
   project idea. We provided links to the background material, known issues
   and current documentation for both project ideas [4] [5]. Choose one
   project you like the most.
   3.

   Start drafting a proposal with the gaps you have found and ideas for
   improvement, and how you would present the new/updated/full documentation.
   Here are more tips on how to make your proposal stronger [6]. Please,
   follow the guides and make sure you cover all points.
   4.

   Submit the project proposal to the Google program administrators during
   the technical writer application phase. It opens on June 9, 2020. If you
   want any  feedback for your initial draft, consider using Google Docs and
   share on dev@beam.apache.org, so the community members can leave their
   comments and suggestions (please check the access to the doc before sending
   to the mailing list).

If you have any ideas that you want to brainstorm about, don’t hesitate to
start a discussion in the community list or reach out on Slack channel to
discuss issues related to GSoD documentation [7]. Once you create an
account join #beam-gsod channel.

Project administrators will assess proposals based on these guidelines [8]

Hope it helps. Let us know if you have more questions.

Thanks,

Beam GSoD team


[1] https://developers.google.com/season-of-docs/docs/tech-writer-guide

[2] https://developers.google.com/season-of-docs/terms/tech-writer-terms

[3] https://cwiki.apache.org/confluence/display/BEAM/Google+Season+of+Docs

[4]
https://cwiki.apache.org/confluence/display/BEAM/Google+Season+of+Docs#GoogleSeasonofDocs-1.DeploymentofaFlinkandSparkClusterswithPortableBeam

[5]
https://cwiki.apache.org/confluence/display/BEAM/Google+Season+of+Docs#GoogleSeasonofDocs-2.Updateoftherunnercomparisonpage/capabilitymatrix

[6]
https://developers.google.com/season-of-docs/docs/tech-writer-application-hints

[7] https://join.slack.com/share/zt-eaml657m-KMamnNZfRF2BB7eQpmvveg

[8]
https://developers.google.com/season-of-docs/docs/project-selection#assess-proposal



On Mon, May 18, 2020 at 8:56 AM Roopal Jain <ro...@gmail.com> wrote:

> I am interested in participating in Google Season of Docs for Apache Beam.
> I went through the proposal and thought this is something I could do well.
> I am currently working as a software engineer and have a B.E in Computer
> Engineering from one of India's reputed engineering colleges. I have prior
> open-source contribution with mentoring for Google Summer of Code and
> Google Code-In.
> I have prior work experience on Apache Spark and a good grasp on SQL,
> Java, and Python.
> I have basic knowledge of GCP. It was mentioned in the doc the new
> features are accessible for Beam contributors, but they are not available
> in the user-facing documentation. I might be able to understand designs and
> features well and as a describe them in layman terms to someone who is
> looking forward to contribute or adapt to a new tech stack.
>
> Please guide me more on how to get started?
>
> Thanks & Regards,
> Roopal Jain
>