This is the content of the website of the Python club at Queen Mary,
University of London. You are welcome to
contribute your articles on any more or less technical topics, not necessarily
related to Python (for instance, if you know a bit about port forwarding using
ssh, and able to f*ck the system and pretend that the school SQL server is
running locally, write it here).
First of all, get an account at github, set up your ssh key, and fork the original repo. Right, you also need to configure git. If you didn't use git before, check out Github tutorial or a tutorial provided by Software Carpentry to get a general idea.
Before writing an article, clone the repo:
git clone git@github.com:username/pyclub.github.io cd pyclub.github.io
We use buildout to deploy needed software. A typical biuldout deployment consists of two steps: bootstrapping and building out.
Bootstraping is simple:
python bootstrap.py
In case you get an error about setuptools, you can install them:
# Only if you get an error in the previus step! python ez_setup.py --user python bootstrap.py
Now you are ready to buildout:
bin/buildout
Once you have a copy of the repo on your computer you are ready to add articles to it.
Just create a file in the content/articles/ folder, for example,
content/articles/001-intro.rst. Follow the convention: first goes the
number of the article (pick the next integer) followed by a short indicative
name. The content of the file should be similar to
.. The title. It's important to put = from below and above!
=============================
Welcome to the QM Python club
=============================
.. Some metadata
:date: 2014-01-28 19:49
:tags: thats, awesome
:category: yeah
:author: Dmitrijs Milajevs
.. Here goes the content of the article.
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
commodo consequat. Duis aute irure dolor in reprehenderit in voluptate
velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat
cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
est laborum.Refer to Pelican documentation and reStructuredText examples if you want nice formatting.
You can use restview to see
rendered .rst files in your browser. For example, to see the intro
article, type:
bin/restview content/articles/001-intro.rst
There are rumors, that you can feed a directory to restview and then select files in the browser:
bin/restview content
Wow, you can get a local version of the blog:
make devserver open http://localhost:8000 # gnome-open on Linux # make stopserver is a logical way to stop the server
Commit and push our changes:
git st # see what you have done git diff # really see what you have done git add RELATED_FILES # probably, somethig like content/articles/001-intro.rst git ci -m'An article describing the enterprise (R) power of Java.' git push # send you changes to github
Create a pull request.
Sharing your knowledge is cool. You can always put in your CV that you contribute to a blog, know git, familiar with peer reviews, and able to read documentation.
You can also directly point to your work. Your next employer will like it.
In case you are lucky and have write access to the main repo you can upload the
generated HTML version of the site, however you need to clone
git@github.com:pyclub/pyclub.github.io.git.
To upload the HTML just run:
make github
This work is licensed under a Creative Commons Attribution 4.0 International License.