DOCUMENTATION
INTRODUCTION
Overview Getting Started
BASICS
Entries Software Design
GUIDES
Contributing Guide Writing Entries
TUTORIALS
Adding Entries Editing Entries
 
Introduction
Overview Getting Started
Basics
Entries Software Design
Guides
Contributing Guide Writing Entries
Tutorials
Adding Entries Editing Entries
Last edit: 23-Jul-26

Adding Entries

All you need is a GitHub account (sign up).

Good reference materials are the Writing Guide and the example entry of the Avocado Lab webpage which is rendered from this file.

Quick start

Not sure which collection fits your initiative? Pick the closest one below — a maintainer can always move it during review. Clicking a link below takes you straight to a new file on GitHub, already named and pre-filled with the entry template, skipping steps 1-4 below:

Community Lab Project Startup Incubator Group Network Event Other

You’ll still need to rename the placeholder folder/file name to match your initiative (keep the .md at the end), fill in the template, and continue from step 5 below.

Step by step

  1. Open Collection Folder: inside the sphere repository (first determine in which collection your initiative belongs to)
  2. Select Create New File: GitHub will let you know you don’t have ‘write’ access to the project — that’s expected, everyone contributes this way. A new file will be saved under your copy of the project (‘fork’) and can later be merged with a ‘pull request’.
  3. Name your new file: Add a folder first, preferably with the same name of your initiative using CamelCase and specify the format at the end as .md, e.g. ‘AvocadoLab/AvocadoLab.md’ (the name of the file will be the URL of the entry, so don’t use a long name!)

  1. Copy and Paste EntryTemplate: open the EntryTemplate, select all, copy, and paste into your new file. Alternatively, use the CompleteTemplate, or base off the AvocadoLabFile as a more concrete example
  2. Edit content: Fill in the front matter (data keys in between ---) and write the rest of the entry in markdown text. The Preview markdown will only render the text and the front matter will be inside a two row table.
  3. Select Propose new file at the bottom of the page, when you are finished editing
Add changes in large batches if possible

Make all the changes you want, even to other files, in your own ‘fork’ or ‘branch’ and merge them all at once

  1. Select Create Pull Request if you are able to merge. You can add additional comments to your pull request
  2. Wait for Review A maintainer will review your Pull Request (PR), request additional edits from you, or approve and merge it.

Rejoice! your new entry is now part of DIYbiosphere! :clap: :clap:

Thank you for your contribution! :heart:

Changes are not immediate

Changes to the files trigger a new build, which can take a few minutes

Comments

Open Comments Issue in GitHub