Home

AWDE Team Wiki

This is a wiki intended to be used by group leaders and maintainers of the AWDE Site. It is a collection of best practices and procedures for keeping everything up-to-date. We want the site to be a useful and reliable source of information so that members have minimal friction when engaging with group activity. That means it's our job to keep the site relevant.

Branching Practice

There are two main types of edits, Non-Code and Code

Non-Code

Since this is static website, most updates will be purely changes to the markdown source files. Since these aren't really code and can't exactly 'break' anything it should be safe to make these edits directly off of main. Major changes to key pages (like the homepage) may need to go in their own branch but this can be left to developer discretion.

Code

Changes to other aspects of the site, like the html templates, javascript, sass source files, or ruby code should go into a development branch with a name like dev/<meaningful-name-describing-change>. These branches can then be merged into main once they're functional.

Versioning

This site is using a peculiar idiomatic versioning practice that refers to the AWDE group as a whole rather than the specific code running the website.

Procedures

Here are some written procedures for common actions

• Create
  • A group
  • A project
  • An event
• Edit a project, group, or event
• Archive
  • A group
  • A project
  • An event