[gimp-web/gimp-web-static] Added 'building' to guide users through building the site
- From: Pat David <patdavid src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gimp-web/gimp-web-static] Added 'building' to guide users through building the site
- Date: Tue, 11 Aug 2015 18:47:44 +0000 (UTC)
commit c0de5b9ba6680cb2c195d75559322d1252dde625
Author: Pat David <patdavid gmail com>
Date: Tue Aug 11 13:47:37 2015 -0500
Added 'building' to guide users through building the site
content/about/meta/building/index.md | 151 ++++++++++++++++++++++++++++++++++
1 files changed, 151 insertions(+), 0 deletions(-)
---
diff --git a/content/about/meta/building/index.md b/content/about/meta/building/index.md
new file mode 100644
index 0000000..c52f19a
--- /dev/null
+++ b/content/about/meta/building/index.md
@@ -0,0 +1,151 @@
+Title: Building WGO
+Date: 2015-08-11T11:56:58-05:00
+Modified: 2015-08-11T11:57:04-05:00
+Authors: Pat David
+Summary: A page about the new site.
+
+
+So you want to contribute?
+Great!
+Here are the steps to follow to get your very own copy of the website!
+
+[TOC]
+
+## git
+
+You will need to get git: <https://git-scm.com/>
+
+The examples here will use git from the command line, but you may be more comfortable using a GUI.
+In that case, find one you're comfortable with.
+If you are going to be contributing and want commit access to the repository, [learn git][] also.
+
+[learn git]: https://git-scm.com/documentation
+
+You can still contribute without commit access to the repository.
+You'll be creating patches instead of pushing changes directly to the repository.
+We'll cover those steps a little later.
+
+
+
+## Get the Source
+
+The source for the GIMP websites can be found here: <https://git.gnome.org/browse/gimp-web/>
+
+At the bottom of that page you should see a section title **Clone**.
+It will provide some common means to clone the repository:
+
+[git://git.gnome.org/gimp-web](git://git.gnome.org/gimp-web)
+<https://git.gnome.org/browse/gimp-web>
+<ssh://USERNAME git gnome org/git/gimp-web>
+
+From your shell, navigate to your desired location to hold the files.
+
+If you are only interested in the new site while it's being developed, you don't have to fetch the entire
repository.
+You can tell git to clone a particular branch (only) into the sub-directory `gimp-web-static`:
+
+`git clone -b gimp-web-static --single-branch https://git.gnome.org/browse/gimp-web gimp-web-static`
+
+That is,
+`git clone -b gimp-web-static`
+clone the branch gimp-web-static
+
+`--single-branch`
+just the branch, not the entire repository
+
+`https://git.gnome.org/browse/gimp-web/`
+the repository we are cloning from
+
+`gimp-web-static`
+into this sub-directory from where we are.
+
+Be patient.
+At the moment the total download size will be around 111MB.
+This is because the gimp-web-static branch is still referencing all of WGO.
+This may be fixed later *or not*.
+So just sit tight while it fetches everything... :)
+
+Once it finishes, you'll have a sub-directory called `gimp-web-static`.
+If you enter that directory and run `git status` you should see some information:
+
+ $cd gimp-web-static/
+ $git status
+ On branch gimp-web-static
+ Your branch is up-to-date with 'origin/gimp-web-static'.
+ nothing to commit, working directory clean
+
+Congratulations!
+You now have your very own copy of the site source code.
+Now we just need to get the rest of the tools in place for you to make use of it.
+
+
+
+## Get Python
+
+You will need to download and install Python 2.7.x.
+
+<https://www.python.org/downloads/>
+
+2.6.x is not supported by Pelican, and there is only rudimentary support for 3.x at the moment.
+
+
+
+## Get Pelican
+
+Install [Pelican](http://blog.getpelican.com/):
+
+<http://blog.getpelican.com/>
+
+The easiest way to get it after installing Python is to use pip:
+
+`pip install Pelican`
+
+
+
+### Some Extras
+
+Some extra components that we use on the site are [Markdown][] and [typogrify][]:
+
+`pip install Markdown`
+`pip install typogrify`
+
+[Markdown]: http://daringfireball.net/projects/markdown/
+[typogrify]: https://github.com/mintchaos/typogrify
+
+
+
+## Build the Site
+
+Once the requirements are installed building the site is straightforward.
+Enter the project directory and issue the `Pelican` command to build:
+
+ cd gimp-web-static/
+ pelican
+
+After a few moments, the command will finish, and the site files will be in the `output` directory.
+
+
+### Auto Rebuild
+
+If you are developing the site or content and want pelican to automatically regenerate the site when files
change then you can run the command with the `-r` switch to reload automatically (and will possibly want to
ignore any caches as well):
+
+ pelican -r --ignore-cache
+
+
+
+## View the Site
+
+To accurately see the site it is best to access it through a web server.
+Python has one built in that can be used.
+Enter the output directory, and start the HTTP server:
+
+ cd output/
+ python -m SimpleHTTPServer
+
+The site will then be accessible to a web browser at:
+
+ http://localhost:8000
+
+Do note that the SimpleHTTPServer won't serve SVG elements as images correctly.
+See [this section][] for a solution
+
+[this section]: ../using-pelican/#python-simplehttpserver-svg
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]