Merge pull request #15 from NemoAndrea/updated-cohort-projects

Make intended-use and development-plans optional fields in cohorts

docs/_static/open-hardware-outcomes.html

@@ -113,8 +113,7 @@
                             console.log(" - " + outcome.name)
                             processOutcome(outcome, entriesEl)
                         }  else {
-                            console.log("and ignoring (not YAML):")
-                            console.log(" - " + outcome.name)
+                            console.log("[ignoring non-YAML file]: " + outcome.name)
                         }
                     }
                 })
@@ -195,21 +194,27 @@
             projectDescription.innerHTML = outcomeData.description
             cardContents.appendChild(projectDescription)
 
-            let headingIntendedUse = document.createElement("h3");
-            headingIntendedUse.innerHTML = "Intended Use"
-            cardContents.appendChild(headingIntendedUse)
+            // these fields may be left as empty strings in the .yml files
+            if (!outcomeData["intended-use"].trim().length !== 0) {
+                let headingIntendedUse = document.createElement("h3");
+                headingIntendedUse.innerHTML = "Intended Use"
+                cardContents.appendChild(headingIntendedUse)
 
-            let projectIntendedUse = document.createElement("p");
-            projectIntendedUse.innerHTML = outcomeData["intended-use"]
-            cardContents.appendChild(projectIntendedUse)
+                let projectIntendedUse = document.createElement("p");
+                projectIntendedUse.innerHTML = outcomeData["intended-use"]
+                cardContents.appendChild(projectIntendedUse)
+            }
 
-            let headingDevelopmentPlan = document.createElement("h3");
-            headingDevelopmentPlan.innerHTML = "Future development plans"
-            cardContents.appendChild(headingDevelopmentPlan)
+            // these fields may be left as empty strings in the .yml files
+            if (outcomeData["development-plans"].trim().length !== 0) {
+                let headingDevelopmentPlan = document.createElement("h3");
+                headingDevelopmentPlan.innerHTML = "Future development plans"
+                cardContents.appendChild(headingDevelopmentPlan)
 
-            let projectDevelopment = document.createElement("p");
-            projectDevelopment.innerHTML = outcomeData["development-plans"]
-            cardContents.appendChild(projectDevelopment)
+                let projectDevelopment = document.createElement("p");
+                projectDevelopment.innerHTML = outcomeData["development-plans"]
+                cardContents.appendChild(projectDevelopment)
+            }
 
             // homepage and close button
             let homepagebutton = document.createElement("button");

participant-projects/2021/we_can_have_different_years_listed_separately.md

@@ -1,23 +1,3 @@
-title: A project in 2021
-description: By travelling back in time we were able to uncover a secret
-intended-use: Time travel is restricted to author of this repository as it comes with great resposibility
-keywords:
-  - 2021
-  - timetravel
-  - demo
-development-stage: released
-development-plans: This demo is stuck in time, and will not see further development
-project-link: https://en.wikipedia.org/wiki/Time_travel
-image: https://upload.wikimedia.org/wikipedia/commons/thumb/8/84/2021-01-01_happy-new-year_Pepper_and_Carrot_by_David_Revoy.jpg/1200px-2021-01-01_happy-new-year_Pepper_and_Carrot_by_David_Revoy.jpg
-license:
-  hardware: GPL-3.0-only
-licensor:
-  name: Nemo Andrea
-okh-manifest-version: 1.0.0
-date-created: 2022-09-23
-manifest-author:
-  name: Nemo Andrea
-contact:
-  social:
-    - platform: twitter
-      user-handle: cursed_tubule
+### Cohort years
+
+We can add different years simply by adding a folder with the name of the year in `yyyy` format. 

participant-projects/2022/anti-bike-theft.yml

@@ -1,20 +1,16 @@
 title: Anti bike theft device
-description: "After having your bike stolen multiple times, you want to prevent your bike from being stolen with this anti theft device, as soon as it moves italarms, if it is stolen you can track it through the lora network with the GPS signal!"
-# intended-use: "The design is focussed on being accessible to people with physical and
-#   cognitive disabilities by use of few and large buttons and simple UI. It
-#   should allow anyone to enjoy music without supervision."
+description: "Lora network-based GPS bike locator & bike alarm."
+intended-use: "After having your bike stolen multiple times, you want to prevent your bike from
+ being stolen with this anti theft device, as soon as it moves italarms, if it is stolen you can
+  track it through the lora network with the GPS signal!"
 keywords:
   - spotify
   - 3D-printing
   - raspberry-pi
   - accessibility
   - music
 development-stage: released
-development-plans: "The project has had an initial release, with some ‘field testing’ to boot.
-  The hardware and software are functional, if a little rough around some of the edges. 
-  Certainly areas to improve on, but none that require immediate attention. All the design
-  files and code are available for reproduction - provided you have basic (electronics) tinkering
-  skills."
+development-plans: ""
 project-link: https://github.com/nanaminh/anti-theft
 image: https://i.imgur.com/eMUdNva.jpg
 license:

participant-projects/2022/automated-microscope.yml

@@ -1,18 +1,14 @@
 title: Automated microscope
-description: "This project started from a desire to improve medical diagnosis in rural communities of low-income countries. In order to contribute in this direction, we decided to design and build a microscopy platform with certain relevant characteristics. We went for microscopy, given its simplicity, versatility, and widespread applications."
-# intended-use: "The design is focussed on being accessible to people with physical and
-#   cognitive disabilities by use of few and large buttons and simple UI. It
-#   should allow anyone to enjoy music without supervision."
+description: "This project started from a desire to improve medical diagnosis in rural communities of low-income countries."
+intended-use: "In order to contribute in this direction, we decided to design and build a microscopy
+ platform with certain relevant characteristics. We went for microscopy, given its simplicity, 
+ versatility, and widespread applications."
 keywords:
   - research
   - microscope
   - automated
 development-stage: released
-development-plans: "The project has had an initial release, with some ‘field testing’ to boot.
-  The hardware and software are functional, if a little rough around some of the edges. 
-  Certainly areas to improve on, but none that require immediate attention. All the design
-  files and code are available for reproduction - provided you have basic (electronics) tinkering
-  skills."
+development-plans: ""
 project-link: https://github.com/jossoca/OHA_micro
 image: https://raw.githubusercontent.com/jossoca/OHA_micro/main/Imgs/micro.jpeg
 license:

participant-projects/2022/plastic-injection-molding-machine.yml

@@ -1,16 +1,14 @@
 title: Plastic injection molding machine
-description: "The plastic injection molding machine by Joost Dommisse is an improved design based on the experience of the community. It solves many of the challenges with the V2 version of the injection machine, and incorporates a framework for others to implement future upgrades."
-# intended-use: ""
+description: "The plastic injection molding machine by Joost Dommisse is an improved design based
+ on the experience of the community. It solves many of the challenges with the V2 version of the 
+ injection machine, and incorporates a framework for others to implement future upgrades."
+intended-use: ""
 keywords:
   - Plastic
   - recycling
   - tool
 development-stage: released
-development-plans: "The project has had an initial release, with some ‘field testing’ to boot.
-  The hardware and software are functional, if a little rough around some of the edges. 
-  Certainly areas to improve on, but none that require immediate attention. All the design
-  files and code are available for reproduction - provided you have basic (electronics) tinkering
-  skills."
+development-plans: ""
 project-link: https://repository.tudelft.nl/islandora/object/uuid:e12d9789-5c51-4570-8a5f-32570c501ba9?collection=education
 image: https://d2k0ddhflgrk1i.cloudfront.net/Thema/Plastic%20injection%20molding%20machine.jpg
 license:
@@ -21,7 +19,4 @@ okh-manifest-version: 1.0.0
 date-created: 2022-09-23
 manifest-author:
   name: Joost Dommisse
-# contact:
-#   social:
-#     - platform: twitter
-#       user-handle: cursed_tubule
+

participant-projects/2022/wiggle-bin.yml

@@ -1,10 +1,10 @@
 title: Wiggle bin
 description: "A smart vermicomposting bin which makes both worms and humans happy! Vermicomposters have worms that help you make compost, but maintaining a worm bin is not without complications, this tackles some of these challenges."
+intended-use: ""
 keywords:
   - worms
   - worm hotel
   - compost
-
 development-stage: released
 development-plans: ""
 project-link: https://github.com/studiorabota/wiggle-bin

participant-projects/2023/acraea-controller.yml

@@ -0,0 +1,26 @@
+title: Acraea Control using an ESP32
+description: "ESP32 microcontroller, Temperature and humidity sensor, Ultrasonic sensor,
+  pumps, relay"
+intended-use: "Program to monitor and control the flow of seawater through Acraea. Acraea is
+  a an open source small scale solar desalination and water purifier prototype.
+  This plant takes heat as input on one side and uses it to boil sea water. This
+  water is then collected on the other side through condensation and allowed to
+  flow out of the system as potable water."
+keywords:
+  - Water Purification
+  - ESP32
+development-plans: The project is being actively developed. We are adding cloud based logging as a feature to continously monitor the performance. We are also migrating the codebase to use environment.
+project-link: https://github.com/shantnavagarwal/Acraea_Controller
+made: true
+made-independently: false
+license:
+  documentation: GPL-3.0-or-later
+  software: GPL-3.0-or-later
+licensor:
+  name: S Agarwal
+okh-manifest-version: 1.0.0
+date-created: 2023-12-07
+date-updated: 2023-12-07
+manifest-author:
+  name: S Agarwal
+  email: [email protected]

participant-projects/2023/esp-pi-camera.yml

@@ -0,0 +1,8 @@
+title: ESP-Pi vision project
+description: "This project consists in hardware and software for capturing images through a camera and a simple board and transfering these photos to a board with higher computational power for further operations." 
+development-plans: "It is an initial step for a more advanced project of object recognition for application in projects such as robots or other devices."
+intended-use: ""
+project-link: https://github.com/fabioschuh/image_capture
+image: https://predictabledesigns.com/wp-content/uploads/2022/02/a-close-up-of-a-circuit-board-description-automat.jpeg
+licensor:
+  name: Fabio Schuh

participant-projects/2023/wiggle-bin.yml

@@ -0,0 +1,26 @@
+title: WiggleBin
+description: "WiggleBin is an open-source, intelligent vermicomposting bin that
+  not only nurtures the well-being of worms but also brings joy to their human
+  caretakers"
+intended-use: Monitoring a vermicomposting bin
+development-plans: "The project is currently in the prototyping phase. The
+  development plan is to create a stable version of the hardware and software
+  and to test it in a real-life environment. Eventual goal is to release a Raspberry Pi Image and a PCB design."
+keywords:
+  - composting
+  - raspberry pi
+project-link: https://wigglebin.gitbook.io
+image: https://raw.githubusercontent.com/wiggle-bin/wiggle-r/main/Images/WiggleRBasicSetup.jpg
+made: true
+made-independently: true
+license:
+  hardware: CERN-OHL-S-2.0
+  documentation: GPL-3.0-or-later
+  software: GPL-3.0-or-later
+licensor:
+  name: Kranendonk, V
+okh-manifest-version: 1.0.0
+date-updated: 2024-02-25
+manifest-author:
+  name: Vincent Kranendonk
+  email: [email protected]

participant-projects/README.md

@@ -18,7 +18,22 @@ We also use the following practices
 * Avoid listing email address of participant for spam concerns. If the participant wants to be contacted that info will/should be present on their project page.
 * The `licensor` is used as the display name rather than the manifest-author. In almost all cases these will be the same anyway.
 
-A minimal example of fields that should be present is listed below
+> **warning** 
+>
+> The example file below contains the **minimal** contents a config file should have
+
+```yml
+title: project-title
+description: "1-3 lines of project description. If more details are required, consider putting in intended-use"
+intended-use: "more depth about the project and use. No length restriction. Leave as EMPTY STRING if you don't want it to show up on the page."
+development-plans: "Describe the future plan for the project. No length restriction. Leave as EMPTY STRING if you don't want it to show up on the page."
+project-link: https://github.com/NemoAndrea/SpotiStation
+image: https://raw.githubusercontent.com/NemoAndrea/SpotiStation/main/media/banner.png
+licensor:
+  name: Nemo Andrea
+```
+
+The example below is a little bit more elaborate; some of these fields are currently not used but might be nice to have for future expansion/functionality.
 
 ```yml
 title: SpotiStation
@@ -56,6 +71,8 @@ contact:
       user-handle: cursed_tubule
 ```
 
+
+
 ### External libraries
 
 For yaml parsing we use [js-yaml](https://www.npmjs.com/package/js-yaml); specifically the minified version 4.1.0