SPARC Community-Owned Infrastructure Microsite

About

This site provides a custom home for SPARC's Community-Owned Infrastructure project materials.

Status

• Live:
• Test:

How to make a new post via Github web interface

Posts are usually different sections of the report.

• You need to have access to add posts to the website. This can be done by adding your github account to the Staff Team.
• Clicking here. That will start a new post in _posts on the dev branch.
• Give your post a name. Your name must start with the date you want it posted plus a friendly title and .md at the end. This means post names look like this YYYY-MM-DD-your-title.md
• Start writing. It can be helpful to start by copying template.
• When you're ready to save, hit commit changes at the bottom.
• The site will then update, this can take about a minute (you can check the status above). You'll find your post at http://test.infrastructure.sparcopen.org/. This will only happen if the post date is today. Think of this as a preview, it won't show up on Google or be discoverable from the live website.
• If you want to make edits to your post, find it in _posts
• Once you're happy, it's time to put your post on the live site. To do that, click here. If it shows only your post as being added, great! If it doesn't, best to reach out to @JosephMcArthur for help. If that isn't possible, clicking here and copy your post. This will put your post directly on live, and while this can be bad practice is fine in a pinch.

How to add a report

• Click here to make a new report file. That will start a new report in _reports.
• Create a file name. It needs start with report and end .md. Keep it just a few words.
• Copy file contents from https://github.com/sparcopen/infrastructure/blob/dev/_reports/report-2021-update.md. This will give you the key field names and some documentation about them. Don't delete any key.
• When you're ready to save, hit commit changes at the bottom.

How to add different type of content

• Threads: Go to _topics, duplicate any file and adjust to your liking. The tag element on posts affect what topic it goes into.
• Reports: Go to _reports, duplicate any file and adjust to your liking. The catagory element on posts affects what report is used.
• Media (e.g images, report PDFs): Go to _media. If you find a folder that makes sense go there, and then upload your image. Then, reference is as you see in the template.
• Authors. If there is a new author go to _data/authors.yml and copy previous entries.

About the code

https://github.com/sssoz was the main designer and developer for this project.

The live version of the site is at https://infrastructure.sparcopen.org/ (using live in this repo).

A dev version is at https://test.infrastructure.sparcopen.org/ (using dev in this repo).

Another version of the site for members exists too.

The site uses Jekyll as a build system, and Netlify for server / CDN.

We forked the original codebase from https://github.com/dbtek/dbyll however we likely stripped just about everything out during the build.