| layout | title | permalink |
|---|---|---|
docs |
Overview of Noodles |
/docs/introduction/overview/ |
🎉 Welcome to the Noodles repository 🎉
We really appreciate your interest in our project and we would ❤️ your contributions!
The Noodles is a open-source project
The platform functions similar to a wiki but uses GitHub Pages instead; hosting the raw files at https://github.com/Progressbar/noodles and rendering webpages at http://sphere.diybio.org
Each DIYbio initiative has its own entry which are organized into eight collections: projects, startups, labs, incubators, groups, networks, events, and others. An entry is added by creating its own folder in its respective collection, and adding a text file in markdown syntax with a YAML front matter, which is then rendered into its webpage. For example, the file _projects/MyDIYbioProject/MyDIYbioProject.md could look like this:
---
# This is the front matter in YAML; between two lines of three consecutive dashes (---)
title: My DIYbio Project
start-date: 2000
type-org: non-profit
website: http://my-diybio-project.io
tags:
- open hardware
- citizen science
---
# This is the text in Markdown syntax; after the front matter
My DIYbio project is about **open hardware** and **citizen science**.
The front matter includes several key: value pairs that render into different elements in the webpage. The Avocado Lab is an example entry for pedagogical purposes. You can check out the raw file raw file rendered into this webpage. See the rendered image below, and by its side the different elements of the page labeled.
To contribute, you need a GitHub account (sign up).
You also need to abide to our Code of Conduct (COC) and consent to our Contributor Terms (CT) determined by our Terms of Use (aka Copyrights)).
TL;DR (Too Long; Didn't Read)
- COC: Be kind and respectful. Gross, rude or inappropriate behavior will not be tolerated. Confront wrongdoers directly or report them to the board of directors.
- CT: You freely share your contributions to the repository under the MIT license. If your contributions are displayed in the website, you freely waive authorship rights of these contributions (public domain; CC0), otherwise you will specify their copyright. You will also note contributions on behalf of third parties and specify their copyright.
In increasing order of engagement you can contribute to DIYbiosphere by:
- SHARING THE LOVE
- Share this project with your friends and followers! They might be interested in using the project to find DIYbio initiatives or adding their own. You don't need a GitHub account for this!
- ⭐ Star the project on GitHub! Starring helps attract potential contributors, especially expert and master developers!
- WRITING ENTRIES
- PARTICIPATING IN THE ISSUES
- Comment, answer, and vote: search our issues and see if you can help out by moving our issues along:
- Submit a new issue: report a bug, ask a question, share your idea and wait for feedback and support from the community.
- Fork, commit, pull request your contributions! Tackle a good first issue to get you started
- GETTING INVOLVED
- Join the development community. The project is managed by members of the DIYbiosphere community. Request membership by submitting an issue enjoy more access privileges to the project!
- Join the conversation. You can freely join the Gitter chatroom at gitter.im/diybiosphere/sphere, or in Slack at diybiosphere.slack.com
In short: the work in DIYbiosphere is freely available to use, modify and distribute. More specifically:
- Files in the Repository are available under the MIT License
- Content in the Website is shared under the public domain by CC0 License
Credit our work as “© DIYbiosphere contributors” or “© DIYbiosphere” with a link to the Repository at: https://github.com/DIYbiosphere/sphere, or the Website at: http://sphere.diybio.org
You can review our Terms of Use for a human-readable version of the copyrights, and our Contributor Terms to understand in legal terms the rights granted and/or waived from your Contributions. For further detail you should read in full both MIT and CC0 licenses.