Below is a project proposal from a technical writer (bcc'd) who wants to
work with your organization on a Season of Docs project. Please assess the
proposal and ensure that you have a mentor to work with the technical
writer.
If you want to accept the proposal, please submit the technical writing
project to the Season of Docs program administrators. The project selection
form is at this link: <
https://bit.ly/gsod-tw-projectselection>. The form
is also available in the guide for organization administrators
<
https://developers.google.com/season-of-docs/docs/admin-guide#tech-writer-application-phase>.
The deadline for project selections is July 31, 2020 at 20:00 UTC. For
other program deadlines, please see the full timeline
<
https://developers.google.com/season-of-docs/docs/timeline> on the Season
of Docs website.
If you have any questions about the program, please email the Season of
Docs team at
[hidden email].
Best,
The Google Season of Docs team
Title: Extend the Table API & SQL Documentation Project length: Standard
length (3 months)
Writer information *Name:* Ayeshmantha
*Email:*
[hidden email]
*Résumé/CV:*
https://drive.google.com/file/d/11LBRBl2f1zpsBPytXv5530zUPjBSIZTD/view?usp=sharingWriting experience: Experience 1:
*Title:* Google Season Of Docs
*Date:* 2019- Last season
*Description:* The primary objective of the project is to develop an
interactive documentation where end users can interact with API’s with try
out options and in the meantime having more descriptive and self explained
description which explains the technical and nontechnical people on what
situation one should use the endpoint.
The current swagger environment is great but for non techies and techies
still it’s harder to get an idea directly without proper documentation. The
main idea would be getting this swagger environment and documentation in
one place with nice representation. With the help of JS, HTML and CSS.
*Summary:*
https://medium.com/@ayeshmanthaperera/gsod19-openmrs-4259aa6356f1https://rest.openmrs.org/*Sample:*
https://rest.openmrs.org/*Additional information:*
https://akayeshmantha.github.io/Project Description Some areas of the documentation have insufficient
detail or are not accessible for new Flink users. Examples of topics and
sections that require attention are: planners, built-in functions,
connectors, overview and concepts sections. There is a lot of work to be
done and the technical writer could choose what areas to focus on — these
improvements could then be added to the documentation rework umbrella issue
{{EXTRA16}} {{EXTRA17}}
Locked
