Merge pull request #2 from processing/master

merge with master

Author: lm-n

Gruntfile.js

@@ -54,7 +54,8 @@ module.exports = function(grunt) {
           '<%= config.dist %>/assets/js/*.js',
           '<%= config.dist %>/assets/img/*.{png,jpg,jpeg,gif,webp,svg,ico}',
           '<%= config.dist %>/assets/p5_featured/{,*/}*.*',
-          '<%= config.dist %>/assets/learn/{,*/}*.*'
+          '<%= config.dist %>/assets/learn/{,*/}*.*',
+          '<%= config.dist %>/assets/contributor-docs/*.*'
         ]
       }
     },
@@ -229,6 +230,12 @@ module.exports = function(grunt) {
         src: ['**', '!build_examples/**' ],
         dest: '<%= config.dist %>/assets/examples'
       },
+      contributor_docs: {
+        expand: true,
+        cwd: '<%= config.src %>/assets/contributor-docs',
+        src: '**',
+        dest: '<%= config.dist %>/contributor-docs'
+      },
       reference: {
         expand: true,
         cwd: '<%= config.src %>/data/reference',
@@ -328,7 +335,8 @@ module.exports = function(grunt) {
             '!<%= config.dist %>/**/README.html',
             '!<%= config.dist %>/**/p5_featured/**/*.html',
             '!<%= config.dist %>/**/learn/*.html',
-            '!<%= config.dist %>/**/examples/*.html'],
+            '!<%= config.dist %>/**/examples/*.html',
+            '!<%= config.dist %>/reference/assets/index.html'],
         options: {
           ignore: [/^This document appears to be written in English/,
                   /^Bad value “https:/,

README.md

@@ -4,12 +4,13 @@
 
 ## How To Contribute
 
-Known bugs and intended new features are tracked using [GitHub issues](https://github.com/processing/p5.js-website/issues). If you'd like to start working on an existing issue, comment on the issue that you plan to work on it so other contributors know it's being handled and can offer help. Once you have completed your work on this issue, [submit a pull request (PR)](https://github.com/processing/p5.js/blob/master/developer_docs/preparing_a_pull_request.md) against the p5.js master branch. In the description field of the PR, include "resolves #XXXX" tagging the issue you are fixing. If the PR addresses the issue but doesn't completely resolve it (ie the issue should remain open after your PR is merged), write "addresses #XXXX".
+Known bugs and intended new features are tracked using [GitHub issues](https://github.com/processing/p5.js-website/issues). If you'd like to start working on an existing issue, comment on the issue that you plan to work on it so other contributors know it's being handled and can offer help. Once you have completed your work on this issue, [submit a pull request (PR)](https://github.com/processing/p5.js/blob/master/contributor_docs/preparing_a_pull_request.md) against the p5.js master branch. In the description field of the PR, include "resolves #XXXX" tagging the issue you are fixing. If the PR addresses the issue but doesn't completely resolve it (ie the issue should remain open after your PR is merged), write "addresses #XXXX".
 
 If you discover a bug or have an idea for a new feature you'd like to add, begin by submitting an issue. Please do not simply submit a pull request containing the fix or new feature without making an issue first, we will probably not be able to accept it. Once you have gotten some feedback on the issue and a go ahead to address it, you can follow the process above to add the fix or feature.
 
 We recognize all types of contributions. This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Add yourself to the [p5.js repository readme](https://github.com/processing/p5.js/blob/master/README.md#contributors) by following the [instructions here](https://github.com/processing/p5.js/issues/2309)!
 
+
 ## Setup
 
 0. Ensure Java is installed. Not installed?  Head over to https://java.oracle.com

contributor_docs/i18n_contribution.md

@@ -200,7 +200,7 @@ In some cases, the text translated from the original .hbs file (written in HTML)
 * The "p5" key in the JSON object contains individual keys for each reference entry, indexed by variable/function/object name.
 * Any entries in the JSON object which are not filled in will be left in English when the page is loaded.
 * This is a somewhat hacky solution and not ideal. However, it comes from balancing the desire to have documentation directly in the source code, with the unwieldiness of having multiple languages of documentation inline. It will be our working solution until a better one is found.
-* The source content for the reference is handled inline in the [p5.js source code](https://github.com/processing/p5.js). See [Inline documentation](https://github.com/processing/p5.js/blob/master/developer_docs/inline_documentation.md) in the p5.js repo for information on how to contribute.
+* The source content for the reference is handled inline in the [p5.js source code](https://github.com/processing/p5.js). See [Inline documentation](https://github.com/processing/p5.js/blob/master/contributor_docs/inline_documentation.md) in the p5.js repo for information on how to contribute.
 
 ### Translation of Examples
 

i18n-tracking.yml

@@ -1,5 +1,7 @@
 es:
   src/data/en.yml:
+    line 428: '  RotatingKnobs'
+    line 559: '  output3-1'
     line 568: '  output9'
     line 569: '  output9-1'
     line 555: '  output1'
@@ -10,7 +12,6 @@ es:
     line 556: '  output2'
     line 557: '  output3'
     line 558: '  output3-1'
-    line 559: '  output4'
     line 560: '  output5'
     line 561: '  output6'
     line 562: '  output6-1'
@@ -206,7 +207,6 @@ es:
     line 424: '  p5.serial'
     line 426: '  p5.tiledmap'
     line 427: '  vida'
-    line 428: '  p5.voronoi'
     line 429: '  p5.3D'
     line 156: '  etc-title'
     line 157: '  older-releases'
@@ -288,218 +288,4 @@ es:
     line 420: '  p5.shape.js'
     line 573: '  output15'
 zh-Hans:
-  src/data/en.yml:
-    line 568: '  output9'
-    line 569: '  output9-1'
-    line 555: '  output1'
-    line 565: '  output8'
-    line 566: '  output8-1'
-    line 572: '  output14'
-    line 554: '  outputs'
-    line 556: '  output2'
-    line 557: '  output3'
-    line 558: '  output3-1'
-    line 559: '  output4'
-    line 560: '  output5'
-    line 561: '  output6'
-    line 562: '  output6-1'
-    line 563: '  output6-2'
-    line 564: '  output7'
-    line 567: '  output9'
-    line 570: '  output12'
-    line 571: '  output13'
-    line 581: '  2019cc_25'
-    line 413: '  p5.EasyCam'
-    line 552: '  2019contributors-conference2'
-    line 412: '  p5.EasyCam'
-    line 425: '  p5.touchgui'
-    line 99: '  2019cc_11'
-    line 108: '  2019cc_20'
-    line 52: '  2015cc_9'
-    line 44: '  2015cc_1'
-    line 45: '  2015cc_2'
-    line 48: '  2015cc_5'
-    line 55: '  2015cc_12'
-    line 56: '  2015cc_13'
-    line 57: '  2015cc_14'
-    line 5: Editor
-    line 13: '  start-creating'
-    line 46: '  2015cc_3'
-    line 47: '  2015cc_4'
-    line 49: '  2015cc_6'
-    line 50: '  2015cc_7'
-    line 51: '  2015cc_8'
-    line 53: '  2015cc_10'
-    line 54: '  2015cc_11'
-    line 58: '  2015cc_15'
-    line 89: '  2019cc_1'
-    line 90: '  2019cc_2'
-    line 91: '  2019cc_3'
-    line 92: '  2019cc_4'
-    line 93: '  2019cc_5'
-    line 94: '  2019cc_6'
-    line 95: '  2019cc_7'
-    line 96: '  2019cc_8'
-    line 97: '  2019cc_9'
-    line 98: '  2019cc_10'
-    line 107: '  2019cc_19'
-    line 109: '  2019cc_21'
-    line 110: '  2019cc_22'
-    line 111: '  2019cc_23'
-    line 545: '  2019contributors-conference-date'
-    line 504: '  participants-title'
-    line 505: '  support-title'
-    line 506: '  support1'
-    line 507: '  support2'
-    line 508: '  support3'
-    line 509: '  support4'
-    line 510: '  support5'
-    line 511: '  support6'
-    line 63: '  copyright-title'
-    line 85: '  support-18-alt'
-    line 86: '  support-19-alt'
-    line 87: '  support-20-alt'
-    line 34: '  p2xh2'
-    line 43: '  p3xh2'
-    line 380: '  blizard.js'
-    line 391: '  p5.localmessage'
-    line 399: '  Rotating Knobs'
-    line 401: '  p5.screenPosition'
-    line 404: '  Shape5'
-    line 406: '  p5.start.js'
-    line 407: '  p5.start2d.js'
-    line 409: '  tramontana'
-    line 373: '  libraries-created-by'
-    line 381: '  p5.ble'
-    line 371: '  community-libraries'
-    line 358: '  p5.ble'
-    line 364: '  p5.createloop'
-    line 368: '  p5.experience'
-    line 377: '  vida'
-    line 363: '  p5.experience'
-    line 329: '  coordinate-system-simple-shapes-p2x1'
-    line 341: '  coordinate-system-simple-shapes-p9x1'
-    line 120: '  coordinate-system-simple-shapes-p9x1'
-    line 386: '  create-your-own4'
-    line 359: '  p5.clickable'
-    line 362: '  p5.dimensions1'
-    line 374: '  p5.play'
-    line 376: '  rita.js'
-    line 379: '  p5.serial1'
-    line 382: '  p5.speech'
-    line 355: '  asciiart'
-    line 356: '  p5.ble'
-    line 360: '  p5.createloop'
-    line 357: '  asciiart'
-    line 361: '  p5.clickable'
-    line 1: Sidebar-Title
-    line 15: footerxh1
-    line 38: '  p1xh1'
-    line 39: '  p1x1'
-    line 40: '  p1x2'
-    line 41: '  p2xh1'
-    line 42: '  p2x1'
-    line 59: '  p4xp1'
-    line 60: '  p4xp2'
-    line 61: '  p4xp3'
-    line 62: '  p4xp4'
-    line 64: '  p4xp6'
-    line 65: ''
-    line 74: '  get-started3'
-    line 2: Skip-To-Content
-    line 3: Language-Settings
-    line 4: Sidebar-Title
-    line 67: '  book1'
-    line 370: '  core-libraries'
-    line 372: '  libraries-core-by'
-    line 400: '  p5.collide2D'
-    line 402: '  p5.dimensions'
-    line 403: '  p5.experience'
-    line 405: '  p5.geolocation'
-    line 408: '  p5.gui'
-    line 410: '  p5.play'
-    line 411: '  p5.particle'
-    line 424: '  p5.serial'
-    line 426: '  p5.tiledmap'
-    line 427: '  vida'
-    line 428: '  p5.voronoi'
-    line 429: '  p5.3D'
-    line 156: '  etc-title'
-    line 157: '  older-releases'
-    line 158: '  github-repository'
-    line 159: '  report-bugs'
-    line 383: '  p5.cmyk.js'
-    line 392: '  marching'
-    line 394: '  ml5.js'
-    line 397: '  p5.Riso'
-    line 476: '  contributors-conference-title'
-    line 477: '  contributors-conference1'
-    line 478: '  contributors-conference2'
-    line 479: '  contributors-conference3'
-    line 480: '  contributors-conference4'
-    line 485: ''
-    line 486: '  2015contributors-conference-title'
-    line 487: '  2015contributors-conference-date'
-    line 488: '  2015contributors-conference1'
-    line 489: '  2015contributors-conference2'
-    line 490: '  2015contributors-conference3'
-    line 491: '  2015contributors-conference-participants-title'
-    line 492: '  2015contributors-conference-diversity-title'
-    line 493: '  2015contributors-conference-diversity1'
-    line 494: '  2015contributors-conference-diversity2'
-    line 495: '  2015contributors-conference-diversity3'
-    line 496: '  2015contributors-conference-diversity4'
-    line 497: '  2015contributors-conference-diversity5'
-    line 498: '  2015contributors-conference-diversity6'
-    line 499: '  2015contributors-conference-diversity7'
-    line 500: '  2015contributors-conference-diversity8'
-    line 501: '  2015contributors-conference-diversity9'
-    line 502: '  2015contributors-conference-support-title'
-    line 503: '  2015contributors-conference-support1'
-    line 512: '  2015cc_4'
-    line 513: '  2015cc_5'
-    line 514: '  2015cc_6'
-    line 515: '  2015cc_7'
-    line 516: '  2015cc_8'
-    line 517: '  2015cc_9'
-    line 518: '  2015cc_10'
-    line 519: '  2015cc_11'
-    line 520: '  2015cc_12'
-    line 521: '  2015cc_13'
-    line 522: '  2015cc_14'
-    line 523: '  2015cc_15'
-    line 139: '  download-intro'
-    line 140: '  editor-title'
-    line 141: '  p5.js-editor'
-    line 142: '  p5.js-editor-intro'
-    line 143: '  editor-includes'
-    line 145: '  complete-library-intro1'
-    line 146: '  complete-library-intro2'
-    line 147: '  complete-library-intro3'
-    line 151: '  includes-2'
-    line 154: '  single-files-intro'
-    line 168: ''
-    line 72: '  support-20'
-    line 76: '  support-23'
-    line 84: '  support-17-alt'
-    line 88: '  support-21-alt'
-    line 541: '  2019contributors-conference-title'
-    line 542: '  2019contributors-conference-date'
-    line 546: '  2019contributors-conference2'
-    line 547: '  2019contributors-conference3'
-    line 548: '  2019contributors-conference4'
-    line 549: '  2019cc_1'
-    line 550: '  2019cc_2'
-    line 551: '  2019cc_3'
-    line 553: '  2019cc_5'
-    line 21: '  support-options'
-    line 100: '  2019cc_12'
-    line 101: '  2019cc_13'
-    line 102: '  2019cc_14'
-    line 103: '  2019cc_15'
-    line 104: '  2019cc_16'
-    line 105: '  2019cc_17'
-    line 106: '  2019cc_18'
-    line 112: '  2019cc_24'
-    line 420: '  p5.shape.js'
-    line 573: '  output15'
+  src/data/en.yml: {}

p5js_guidelines.pdf

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>p5.js Contributor Docs</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+  <meta name="description" content="p5.js Contributor Docs">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <link rel="stylesheet" href="https://unpkg.com/docsify/lib/themes/buble.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      auto2top: true,
+      executeScript: true,
+      loadSidebar: 'sidebar.md',
+      autoHeader: true,
+      loadNavbar: 'navbar.md',
+      mergeNavbar: true,
+      subMaxLevel: 2,
+      themeColor: '#ed225d',
+      basePath:
+      'https://raw.githubusercontent.com/processing/p5.js/master/contributor_docs/',
+      logo: '../assets/img/p5js.svg',
+      name: 'p5.js Contributor Docs',
+      repo: 'https://github.com/processing/p5.js',
+    }
+  </script>
+  <script src="https://unpkg.com/docsify/lib/docsify.min.js"></script>
+</body>
+</html>