Skip to content

Editing The Website

Sam Matthews edited this page Aug 16, 2014 · 14 revisions

tl;dr

  1. Signup/Login to github.
  2. Edit this month's meeting agenda markdown file
  3. Committing changes will directly modify the source if you are a contributor to the repository, or will fork and create a pull request if you are not.

Overview

This document is designed to illustrate a few of the main methods in which a user can modify content on cugos.org. There are a few methods to modify content, some of which are:

NOTE: cugos.org is powered via github pages. Furthermore, the repository is parsed through Jekyll by GitHub, allowing users to create site content through GitHub Flavored Markdown syntax.

Method One: Editing Via GitHub's Editor

One straightforward way to edit the site is to simply use github's own built in text editor. If a user is a member of the cugos github org, edit's will result in commits directly to the repository. Otherwise, a fork and pull request will be issued.

Step One: Select a Page to Edit

Source for the content of the site are contained within the _posts directory. From here, select a particular file relating to the meeting or item of interest you wish to edit. You'll see the content of the file rendered using GitHub's internal markdown parser. Click the edit button to open GitHub's text editor.

QUICK LINK: Adding yourself to the agenda? Go Here. Posts are sorted by date, with the most recent item appearing at the bottom of the list.

Edit Button

Step Two: Edit The Page

Use the text editor to add/modify your content of interest. See the GitHub Flavored Markdown syntax documentation for reference with syntax.

Edit Console

Step Three: Commit Your Changes

Once your finished, add a commit summary, using the form at the bottom of the page. Adding a quick description of your changes can be extremely helpful for other users of the repository. A simple one-liner of what you added or modified is great. click Propose File Change when finished.

Propose File Change

Step Four: Create the Pull Request

If you're not authorized to edit the repository directly, you'll be taken to a screen allowing you to create a pull request. Click Click to create a pull request for this comparison to initiate the pull request process.

Create Pull Request

Finally, click Send pull request to complete the process. This will alert administrators of the repository that you've made your changes, and would like them incorporated into the site.

Submit Pull Request

Step Five: Confirm Pull Request Is Open

You'll be taken to a screen with your now open pull request. When it has been accepted, this pull request will be marked closed.

Confirm Pull Request

Fork, Edit, Pull Request