Developer procedures

Summary

This page describes some procedures related to Framesoc maintenance.

Procedures

Update Framesoc website

Framesoc website is automatically generated by using the GitHub page generators and taking the README.md as input. To update the website the procedure is the following:

• Update the file README.md, commit and push it on Framesoc repository.
• From the Settings page,
  go to the Automatic page generator.
• Press the Load README.md button to load the README.md content.
• Press Continue to layouts and chose the Slate layout.
• Press Publish Page.

Note: to change the existing images (or add new images or other kind of resources), you have to add them on the gh-pages branch of Framesoc repository. This branch contains the actual website content. In the README.md you will have to use the whole url of these resources.

Add a new page to Framesoc wiki

When you add a new page to the Framesoc wiki, you have to update the wiki sidebar as well. Therefore, the procedure to follow is:

• Create the new page.
• Update the sidebar, adding the new page to the right section.