This repo was the previous home to the Interlock Rochester website. It will soon be removed. Please see latest repo at
Please consider opening an issue for any question you have or bug you might notice in the web page before attempting anything below.
Interlock members might also wish to raise concerns on the interlock-rochester Google Group.
The following is just a rough guide. It will help a great deal if you have some experience editing text configuration files as well as using git, GitHub, and python virtual environments.
The Pelican static website generator is what we use. It is extensively documented.
A great deal of our content was converted automatically from WordPress into Pelican-flavored reStructuredText format files, and then hand-corrected.
Most content created or modified after that has been in Markdown.
If you don't have a github account, create one.
Navigate to
https://github.com/Interlock-Rochester/interlock-rochester.github.io.src
click the fork button.
sudo apt install pelican
Note: This may give you and old, incompatible version of Pelican
Alternately, issue
pip install pelican
possibly in a virtual Python environment created with the
virtualenv
command.
If using a virtual environment, be sure it is active before installing or trying to use pelican.
mkdir interlock_website
cd interlock_website
git clone [email protected]:your-github-username/interlock-rochester.github.io.src.git
cd interlock-rochester.github.io.src
git remote add upstream [email protected]:Interlock-Rochester/interlock-rochester.github.io.src.git
Be sure to substitute your own github account name in place of your-github-username
Be sure you're working from the newest version of the site each time by either pulling or fetching and merging from upstream:
git pull upstream
git fetch upstream
git merge upstream
You can change or create files as either reStructuredText (.rst) or Markdown
(.md) but these files need to be somewhere within the content
directory.
Start Development version of site:
./develop_server.sh start
View your development version in your web browser at:
http://localhost:8000
Repeat the edit-test process as often as necessary to get the result you seek.
The development server will continue to run in the background, incorporating changes, until you stop it:
./develop_server.sh stop
Once you're satisfied with your changes and the test out OK:
git add [list of changed files]
git commit
git push
Now, because it's stupid, you will also push to the HTML branch:
cd output
git add -A
git commit -am 'adding all of these stupid HTML files'
git push origin master
(Typically one will develop on a separate branch from master but how to do that is beyond the scope of this README.)
Navigate to your fork of the src repository, eg
https://github.com/your-github-username/interlock-rochester.github.io.src
Click the New pull request button near the upper-left above the file listing.
Click the green Create pull request button to submit it.
After changes have been submitted, they will be reviewed and, if appropriate, merged and a new copy of the site built and uploaded.