Skip to content

Home

Jump to bottom
bparticle edited this page Apr 4, 2021 · 10 revisions

Welcome to the er301-hub wiki!

Disclaimer: this is a Beta version and the structure of the contributor's pages will change over time. I'm happy for you to contribute as long as you do it with a tester's attitude and you're fine with refactoring once or twice. That being said, while there are just a handful of projects I can update the contributions myself while adding functionalities or refactoring the metadata.

If you want to add your contributions to the ER-301 hub these are two ways to do it

Pull request

the steps to follow:

  • Pull the repository
  • Add your files to the static assets folder /static/packages and/or link your GitHub releases
  • Add a markdown file with metadata frontmatter in the content folder /content/projects (example below)
  • Don't forget to reference your files in the yaml otherwise they won't show up on the project page!
  • Submit a pull request so I can merge your changes in the master branch

About the project markdown file, here is a commented markdown file for an example project https://raw.githubusercontent.com/bparticle/er301-hub/master/content/projects/example.md If you open this file in the UI, it will style the content so you can't really see what's going on This project is not listed in the index but can be accessed directly on this URL https://er301-hub.netlify.app/projects/example

It it is important to follow the syntax of the markdown frontmatter because we are using it for the search functionality, page routing and everything that makes the site work.

Some pointers:

  • Start and end frontmatter with three hyphens
  • Minimum required fields for ensuring the site's functionality are (for now): title, compatibility, units, **categories. Failing to add these fields will crash the site (don't worry, I'm testing any contribution first)
  • The compatibility field is an object with key: value syntax and it looks like this compatibility: { v05: false, v06: true }
  • Put units and categories each on their own line starting with a hyphen

Ask me to add your files

If you are not familiar or comfortable with GitHub and code, contact me on GitHub, or on the Orthogonal Devices forum @bparticle, send over your files and data and I will gladly add them to the repository.

Clone this wiki locally