Update the website

Okay, updating mediagoblin.org! Well, obviously not everyone has permission to do this, so depending on whether or not you have commit access affects whether or not you'll send a branch for review, pretty much the same as how you do with normal git contributions.

= First time =

Easy version
First, do a git checkout:

https://notabug.org/mediagoblin/mediagoblin-website.git

Don't have commit access? Then you should probably make a clone and put it up somewhere.

git clone https://notabug.org/mediagoblin/mediagoblin-website.git

Okay, Make sure you have virtualenv installed (is it on your path? If not you might need to install it via your package manager.) Set up the virtualenv

make virtualenv

Next, to build the site and test it in your browser, run:

make

That's it! If all is successful, it should give you a url like http://localhost:5000/

Harder version
First, do a git checkout:

https://notabug.org/mediagoblin/mediagoblin-website.git

Don't have commit access? Then you should probably make a clone and put it up somewhere.

git clone https://notabug.org/mediagoblin/mediagoblin-website.git

Next, switch to the "draft" branch, or make a local clone of that if you haven't already.

git branch draft origin/draft git checkout draft # merge in any stray commits from master git merge origin/master

First of all you will need to install Pelican to generates the site and Paste to serve it locally for testing purposes. The recommended way to do this is inside virtualenv.

Okay, make sure you have virtualenv installed (is it on your path? If not you might need to install it via your package manager.)

Set up the virtualenv

virtualenv ~/virtualenvs/pelican cd ~/virtualenvs/pelican . bin/activate

Set up Pelican and Paste pip install pelican typogrify PasteDeploy

Asssuming you have a copy of the repo in yout virtualenv's folder, you can now build the site and test it in your browser:

cd mediagoblin-website make html && paster serve blog.ini

That's it! If all is successful, it should give you a url like http://localhost:5000/

If that works, you should be able to visit that URL in your browser and it'll look like http://mediagoblin.org/

= Layout of the repository =


 * content/ -- new blogposts go here. Usually we use restructured text.  Copy an old file and mime it.
 * plugins/ -- Pelican plugins.
 * static/ -- images and stuff goes in here. Look around and you'll see.
 * theme/template/ -- site's template "look and feel" described here.
 * theme/templates/pages/ -- various non-blog pages of the site. Join page, about us, etc.

= Making and committing changes =

Make sure you're in the draft branch:

git checkout draft git pull

Add files, make changes. To test them, activate the virtualenv, recompile, start the server... you'll then be able to visit http://localhost:5000/ in your browser.

. ../bin/activate make html && paster serve blog.ini

Commit to the draft branch when things look good. (This might be more complex if you don't have commit access.. if you're a guest contributor, ask for help in the channel if you get stuck.)

# See what files need to be committed here git status # Stage changes that you intend to commit git add file1.rst file2.html # replace with real filepaths here # Commit! You'll be prompted by your text editor git commit -m "Describe your changes here" # Push live git push

= Going live =

Are you ready to go live? Are you sure? It's probably a good idea to run by Will or Chris in the channel before doing this.

If you're ready, commit and push to the master branch. Changes to the master branch are periodically auto-updated on the server.

git checkout master git pull git merge draft git push