Final Project Proposal Template

November 5, 2018 · View on GitHub

Project Title

Tracking of p5.js Spanish website translation and development of a translation guide (for any language)

This project consist in a collaboration with the internationalization process of p5.js, which has been driven collaborators working in framework development and translation of content. My project proposes a tracking and editing of the former Spanish translation. A guideline document will also be written for new translations based on the existing translation documentation in the p5.js Github repo. This project will be developed for first-time contributors and non-English speakers.

Team Members

Guillermo Montecinos

Define the problem.

The internationalization of p5.js through it's website has been a great decision in terms of spreading p5.js' ideals and making programming easier to non-English speaking users. This process has meant a great effort in order to designing a flexible website structure and keeping track of the changes made in the English. Currently there are two official translation: Spanish and Chinese. The Spanish version hasn't been thoroughly checked by other people and there are also some missing translations due to the ever-evolving nature of the website, with new additions to the reference, examples and tutorials.

In terms of structure, p5.js website has two ways of building. The Reference pages are entirely written in English and swapped out using JavaScript. On the other hand, the non-reference pages are developed in HTML using handlers which display the text contents in the language the page is to be rendered, which are stored in .yml files.

All the information for the website translation can be found in the README file of the website repo, but it can be still improved, so that it can be wrapped in a separated file with examples and a more detailed explanation as it's said in the issue #23 of the Final Projects repo.

The final audience of this project are non-English speaking first-time p5.js contributors and users -this includes coders, educators and students-, and collaborators interested in developping and contributing in the translation of the website.

Address Greater Landscape

p5.js is an open source community-driven project created by Lauren McCarthy and the Processing Foundation as a web re-interpretation of Processing. Technically, p5.js is a set of functions for JavaScript that allows the user to create visual and sound interactive applications on the browser, with a easy-to-use syntax.

As a part of the Processing Foundation, p5.js was intended as a vehicle for spreading coding literacy between the non-programmer community, specially the under-represented and discriminated ones. Furthermore, p5.js is a Free Libre Open Source Software (FLOSS) and therefore an alternative to corporate and exclusive softwares.

Deliverables

This collaboration will be split in two parts: (1) the track, correction and translation of non translated contents of Spanish website in order to solve the gaps between the last translation done by Aarón Montoya-Moraga and the last modifications an adds on p5.js reference and examples, and (2) the development of a TRANSLATION.md document in which all the guidelines and examples for future translations of the website are wrapped, with a focus on first-time contributors to the project and non-English speakers.

  1. Track, translation and correction of Spanish p5.js website
  2. Track, translation and correction of Spanish p5.js reference
  3. Track, translation and correction of Spanish p5.js examples
  4. Write TRANSLATION.md

Implementation

This project won't require particular technical skills besides Git, Github, basic JS and basic HTML. The implementation of this collaboration will consist in the modification of HTML, JS and .yml files where the translation content is stored, and the creation of a Markdown file.

Timeline

This project will be completed over 5 weeks (Nov 6 - Dec 11). Describe a timeline in detail below.

Week 1

  • Track, translation and correction of Spanish p5.js website
  • Track, translation and correction of Spanish p5.js reference (1/2)

Week 2

  • Track, translation and correction of Spanish p5.js reference (2/2)

Week 3

  • Track, translation and correction of Spanish p5.js examples (1/2)

Week 4

  • Track, translation and correction of Spanish p5.js examples (2/2)
  • Write TRANSLATION.md (1/2)

Week 5

  • Write TRANSLATION.md (2/2)
  • Final documentation

Documentation

I will document this project in my own OSS repo through posts published in the Final Project folder. Additionally, the project progress will be tracked on issues I'll post in the p5.js repo and the final pull requests I'll commit when the project is finished. I'll make an effort to cross-reference post and issues/PRs.

Accessibility

TODO

Mentoring

For this project a mentor guide will be needed mostly for organizing and structuring the output guide/wrapping file. I propose the following highly experienced people for this:

  • Lauren McCarthy
  • Aarón Montoya-Moraga
  • Kenneth Lim

More about you

I'm interested in the weird space where technology and art intersects and can describe myself as a technologist and a musician.

I am also an educator and co-founder of a media arts school in Chile called Coded Escuela, where a group of artists and tech people teach creative code and FLOSS tools to creative people. With Coded we have contributed with the internationalization of Processing in Spanish by teaching creative coding with p5.js and with the translation of the website and book which was leaded by Aarón Montoya-Moraga and supported by us.

This project is framed within my previous work in the field of FLOSS education and with the Processing Foundation (on 2017 I spoke in the Processing Community Day @ MIT Media Lab).

You can check my work on Github or visiting my Portfolio.

References

This proposal template was created with material and advice from: