1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
ODM Portal
==========
This is the content for http://odm.ubuntu.com (and http://hwe.ubuntu.com), and is controlled by [Hyde](http://hyde.github.io/) - a static site generator.
TL;DR
-----
$ bzr checkout lp:odm-portal
$ cd odm-portal
$ make
$ make serve # this will keep running until you kill it
$ vi content/ # edit/review/rinse/repeat
$ bzr ci # don't forget to push if this is a branch and not a checkout
$ make live
A brief warning
---------------
Not all the content on odm.ubuntu.com is controlled by this repository - be careful creating new directories or files in case they conflict with existing ones.
Permissions
-----------
In order to publish content, you will need:
* SSH access to cranberry.canonical.com
* Membership of the warthogs group
If you do not have these, please raise an RT.
Installation
------------
You could assume by the fact you're reading this file that you already have checked out the project, but just in case...
$ bzr checkout lp:odm-portal
You will need to have the following packages installed:
* python-virtualenv
* python-pip
To create the virtualenv and install hyde:
$ make
Content
-------
Edit/add your content in the `content` folder, creating folders as necessary. See existing content for examples.
Layout
------
You shouldn't need to modify the layout, but if you do dig around in the `layout` folder.
Generating
----------
To regenerate the content (into the `deploy` folder), run:
$ make gen
To serve the generated content - and continuously regenerate while doing so - run:
$ make serve
Publishing
----------
Currently the only difference between development and production is the inclusion of Google Analytics.
To generate the production version, run:
$ make production
To both generate the production version and rsync it to the server, run:
$ make live
|