Season of Docs

Google Season of Docs gives technical writers an opportunity to work with open source projects.

Layer5 is planning to participate in the Season of Docs in 2020. We’ll announce more details pending our acceptance into the program.

Program Maintainers

2020 Project Ideas

Improve Meshery’s Documentation

API Documentation

  • Prepare Meshery’s API Endpoint Documentation using Swagger.
  • Facilitate a documentation that provides developer playground and test interactions.

User Tutorials

  • Create structured, hands-on user tutorials that walk users through various user flows (similar to https://tutorials.keptn.sh) Developer / Contributor Framework
  • Participate in the design of a dynamic framework for developers to use to ensure that error codes presented to users include a common set of metadata (e.g. a unique error code, description, likely cause, and suggested remediations)
  • Identify and enforce standardized release notes practices.

Set of Project Docs

  • Design and create a complete set of User Guide, Admin Guide, Install and Upgrade Guide, Developer Guide, and so on.
  • Identify opportunities for improvements in current documentation website.

Project goals

Our goal is to have helpful, consistent, and integrated tutorials for contributors, and readers of API reference docs.

  • Use the Swaggo to generate the API Endpoint documentation.
  • Use any open-source training track tool to create tutorial for Meshery and performance management.
  • Update the contribution documentation and create an user guide for Meshery.

What you’ll learn

A writer who takes on this project will learn:

  • How to work with stakeholders in open source projects
  • How to work with different open-source tools to create training tutorials
  • How to work with different service meshes & service mesh architecture
  • How to create and render beautiful API docs
https://layer5.io/gsod/2020
layer5.io
crawl=CC-MAIN-2020-24
53639
application/http; msgtype=response
sha1:Q74ZU6GQGI4FCAZKV6VP2G7N4FQPTGK7
<urn:uuid:dfd35aba-c047-4746-980e-34cd2fb4c319>
2020-06-02T04:34:54Z
185.199.109.153
text/html
sha1:2KEF2VGMI2ACUMOU2WW45ZVVOBJKQJ4R
<urn:uuid:c08cf94d-4b08-4459-844e-a91ac2a6a64a>
https://layer5.io/gsod/2020
response
<urn:uuid:0939ce98-d8dc-43cf-9e7b-4f40749199e4>
isPartOf: CC-MAIN-2020-24
publisher: Common Crawl
description: Wide crawl of the web for May/June 2020
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-236.ec2.internal
software: Apache Nutch 1.16 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.1-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/