# Contributing to this Website

You wrote some documentation about some soundworks related stuff that could be useful to others, or you would like to fix or even improve existing content (which might be a great challenge)? Please contribute!

Note

This site is generated using vuepress, full documentation can be found at https://vuepress.vuejs.org/ (opens new window)

# Install

  1. Clone repo and go to sources branch where the source files are located
git clone git@github.com:collective-soundworks/collective-soundworks.github.io.git
cd collective-soundworks.github.io
git checkout sources
npm install

# Run Development Mode

Get remote changes

git pull origin sources

Start the development server

npm run dev

Go to http://127.0.0.1:8080 (opens new window) in your favorite browser (which shall not be Safari) to see the development preview and edit some content (cf. examples).

# Publish

Note

The following commands will only work if you are part of the soundworks team. Otherwise, proceed the usual steps and create a pull request for changes.

Push your changes on the source branch

git add -A
git commit -m 'your message'
git push origin sources

A Github action will build the website and deploy it automatically (this can take a few minutes).

# Examples

# Adding a "Misc" Page

  1. Add your markdown file in the /misc directory

Note

If your file is quite long, it can be nice to insert a "table of content" on top of it using the [[toc]] macro:

# My Awesome Document

[[toc]]

## subsection 1

Lorem ipsum dolor sit amet...

## subsection 2

Duis aute irure dolor in...

cf. https://vuepress.vuejs.org/guide/markdown.html#table-of-contents (opens new window)

  1. Add your page to the sidebar menu
  • Open the .vuepress/config.js
  • Add the path to your markdown file in children entry of the 'Misc' object:
{
  title: 'Misc',      // required
  path: '/misc/',     // optional, which should be a absolute path.
  collapsable: false,  // optional, defaults to true
  sidebarDepth: 2,    // optional, defaults to 1
  children: [
    '/misc/setting-up-environment',
    '/misc/local-deployment',
    '/misc/contributing-to-this-site',
    // add your file here
  ]
},
  1. Publish

# Adding a "Tutorial" Page

Creating a "tutorial" page follow the same process as a "Misc" page, except your file should be placed in the /tutorials directory and the link in the side-bar should be placed in the Tutorials entry of the config.js file:

{
  title: 'Tutorials',      // required
  path: '/tutorials/',     // optional, which should be a absolute path.
  collapsable: false,  // optional, defaults to true
  sidebarDepth: 2,    // optional, defaults to 1
  children: [
    '/tutorials/state-manager',
    // add your file here
  ]
},
{Sound Music Movement} Interaction Team - STMS-LAB