diybiosphere / sphere

DIYbiosphere is an open-source project to collect Do-it-Yourself Biology (DIYbio) initiatives from all over the world

layout	title	permalink
docs	Overview of DIYbiosphere	/docs/introduction/overview/

🎉 Welcome to the DIYbiophere repository 🎉

We really appreciate your interest in our project and we would ❤️ your contributions!

About

The DIYbiosphere is a open-source project to connect Do-It-Yourself Biology (DIYbio) initiatives from all over the world. The goal is to have a shared and common platform that can connect people and ideas in all its possibilities and encourage the DIYbio community to work on a project together.

How it works

The platform functions similar to a wiki but uses GitHub Pages instead; hosting the raw files at https://github.com/DIYbiosphere/sphere 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.

{:.ui.fluid.image}

Contribute

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
  • Add a new entry: whether it's your initiative or someone else's
  • Edit an existing entry: misspellings, outdated information, or just inaccurate, help us keep the entries error-free and up-to-date!
• 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

Copyright

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.

sphere's Issues

Create necessary shields

There are many README badges we can add, we can either take existent ones or do new ones from shields.io

Implement omnibar functionality

The header search bar is intended to be an omnibar 🔍 where the user can search for text in the whole site.

Implement advanced search

@cube5 commented on Wed Mar 30 2016

Advanced search should include (at the moment) filters by:

• Region (using UN geoscheme for regions and subregions)
• Status
• Last update
• Founding year
• Location
• Initiatives
• Entity type
• Keywords

Live website, what domain?

Hey @cube5 none of the names worked for me.
sphere.diybio.org -> just redirected me to diybio.org
diybiosphere.github.io -> 404 page
diybiosphere.io -> blank page

Create artboards for the website

@sabgaby commented on Thu Mar 24 2016

The artboards are being designed through Sketch

sass folder and files

@sabgaby commented on Tue Apr 05 2016

hey @cube5, do you think we could code the style in sass instead of css? It's easier to write and read

---

@cube5 commented on Tue Apr 05 2016

I agree, no problem 👌

request membership

@sabgaby can you please add me as a member?

Create a nice 404 page

Unfortunately broken links are sometimes unavoidable, and in the beginning of the project there are many of these. In order to help the users find or create what they were looking for, we should create a 404 page with the appropriate resources and links to guide the users.

User form for creating entries

We should consider that maybe users will be discouraged by GitHub's online GUI, and creating a file and so on may seem daunting. An alternative may be to create an entry could be an input form.
This form would be linked to the landing page button "+ Add DIYbio initiative"

Add a Gitter chat badge to README.md

@gitter-badger commented on Mon Apr 04 2016

DIYbiosphere/diybiosphere.github.io now has a Chat Room on Gitter

@sabgaby has just created a chat room. You can visit it here: https://gitter.im/DIYbiosphere/diybiosphere.github.io.

This pull-request adds this badge to your README.md:

If my aim is a little off, please let me know.

Happy chatting.

PS: Click here if you would prefer not to receive automatic pull-requests from Gitter in future.

Sidebar srcoll and position absolute

The sidebar should keep in its position even through I scroll down on the content of the page for easy navigation..

Create a DOI

We can create a DOI so that the project is citable. However, we need

Create a simple Getting Started guide

The Getting Started will give contributors an idea of the ways the can contribute to the project

Submenu does not show completely

The subnavigation/submenu is not showing completely in the entries layout, and in the docs layout it is not vertically aligned in the middle

Convert address to Latitude and Longitude

From the address (Street and number, postcode, city and country) should render a latitude and longitude.
Entries with only the location should render also a latitude and longitude of the "city center"
@cube5: do we need the postal code in order for the geocoding API to render appropriately? It should then be in the front matter of the entries.

Update site to v2 design

See https://app.zeplin.io/project.html#pid=5704d7f108e24e3f7da98f5b&dashboard

Relaying messages from Gitter to Slack

So, this will depend on which platform gathers more user base.
But I found this script for a webhook to relay Gitter messages to Slack.

Create a Sort and Filter pop up in list of initiatives

In the table view of the initiatives and in the landing page button. There should be a basic option for checking and unchecking what you want to display.

I will try to come up with the design

Not used - Ignore me

Ignore this

Create a simple tileset map

Create a simple map with pins from the entries

Slackin implementation

It would be nice to have a more open way to invite people to Slack. Slackin provides this. I don't understand well how to implement it though. I don't understand it from the side of setting up a server.

Suggestions of Jekyll Plugins

I went through the list of jekyll plugins and I am attaching each to a comment so they can be voted on!

Create basic documentation for contributions!

There is a lot of missing documentation in order to support contributors and users! We contemplate that many contributors will be completely new to GitHub and maybe Markdown. Therefore tutorials should include as many helpful hints as possible

Adjust design according to artboards

@cube5 commented on Wed Mar 30 2016

The current design will be readjusted to match the current (and cooler 🤘) artboards.

---

@sabgaby commented on Wed Mar 30 2016

We are in the process of hiring a professional designer! So this should wait a bit!!!

---

@cube5 commented on Wed Mar 30 2016

Nice! no problem I'll drag it in To Do's pipeline

Specify contributing guidelines

The CONTRIBUTING file is what contributors would see in order to contribute to the project. It has to be very complete and link to appropriate resources, and it should be easy to follow

Implement estimated reading time in Support section

So I was thinking that adding an estimated reading time (i.e. 2 min read) might encourage viewers to actually read the guides. I saw some blogs on how to do it on Jekyll:
Jekyll reading time without plugins
reading time
simple reading speed estimate in jekyll

No rush on this!

Advanced Search and Filter

The button in the landing page.. maybe the same one when displaying the list of initiatives...
Here is GIF of how the search and select function works in google sheets, and a copy of the design artboards

Embed gitter chat in website

I saw this, and thought it might be interesting. Don't think it is useful for the moment though
Sidecar

Create initial layouts

@cube5 commented on Wed Mar 30 2016

• Create layouts and js scripts to use when listing entries (Projects, Labs & Groups).
• Create initial layout to use when displaying information of each entry alone.

Missing .gitignore file

Shouldn't we have a .gitignore file in the repository?

Create landing page

@cube5 commented on Wed Mar 23 2016

https://diybiosphere.github.io/

Add padding to content

Increment both side padding of the main content.

Gitter chat on website won't close

The gitter sidecar does not have a close button anymore and it wont close with ESC or with anything

-

Ignore me

Detail install instructions

Instructions to build the local environment for Mac, Windows and Linux users

Fix alignment of elements

things are misaligned in the docs layout.. should be fixed

Implement Google Analytics

We could learn about how users are using the website for improving the user experience

Atom.io for local writing

Can we set up simple instructions so that writers use Atom for local development? Ideally, they would be able to see the Markdown preview in a browser inside of Atom with the styles from the project. We should specify packages for Markdown and Jekyll and others that might be helpful

Adjust design and code

We need to adjust the design and feel of the website. More padding, more clean, and consistent.

Set up custom domain redirect

We have access to:
diybiosphere.io
diybiosphere.com
diybiospere.net
diybiosphere.org

Show only selected social media in infobox

The infobox in the entries, in the social media icons, only the ones that are selected in the front matter of each entry should show.
Selected in this sense means: filled in with a hyperlink, or those ones that are not deleted from the front matter.
In addition, they should resemble the design. Float from right to left.

Creating a or "communal" GitHub account

Someone suggested to me that as users may be deterred to participate since they have to have a GitHub account, that maybe we could create a communal account with a shared password, so that anyone could enter and create changes from that account. A project maintainer would have to be the sole owner of the recovery email in case a troll changes the password.

This might be too complicated, but it was just a suggestion

Can't run jekyll serve

I can't run internally the build system. It tells me I am missing gems but they are installed, I can even check the version. However, I can do bundle exec jekyll install and it will run. Here is a screenshot

Redesign layout using bootstrap

Bootstrap is a well know responsive framework for web development.
The current design will be migrated in order to continue development and design.

Implement map functionality

Give Life to map so users can select a specific region 🗺

Mozilla Sprint excersices

We are joining the Mozilla Sprint! We are Issue 44!

Include warning not working

Hey @cube5 ! I tried putting the includes in the hints but I can't seem to get them to work.. Can you help me out? Thanks!

Mapping entries

We want to be able to map the entries.
Possible software includes:
CartoDB
MapBox
Leaflet

Additional visualization software:
D3

Implement i18n

"Internationalization (i18n) is the process of developing products in such a way that they can be localized for languages and cultures easily." - Wikipedia

Integrate with Travis CI

Integrate with Travis CI to allow i18n and other useful plugins and quality checks.