| 8 |
from a page layout file and files that contain the bodies of every page. |
from a page layout file and files that contain the bodies of every page. |
| 9 |
|
|
| 10 |
FAQ and Release Notes sections of the website are generated by scripts that are |
FAQ and Release Notes sections of the website are generated by scripts that are |
| 11 |
in folders faq/ and relnotes/, respectively. The rest of the pages are just |
in folders faq/ and relnotes/, respectively. The whole build process |
| 12 |
|
is managed by the updatepages.py script. The rest of the pages are just |
| 13 |
plain html files in folder pages/. |
plain html files in folder pages/. |
| 14 |
|
|
| 15 |
|
|
| 46 |
Required accounts |
Required accounts |
| 47 |
----------------- |
----------------- |
| 48 |
|
|
| 49 |
The sources of the website are kept in folder skencil.org/ in Skencil's |
The sources of the website are kept in folder "website" in Skencil's |
| 50 |
"Software" CVS repository on Savannah. To make changes to them you either have |
"Software" SVN repository on wald.intevation.org. To make changes to them you |
| 51 |
to send us patches or get commit permission from us which requires a |
either have to send us patches or get commit permission from us which |
| 52 |
Savannah account and becoming a member of the Skencil project at Savannah |
requires a wald account and becoming a member of the Skencil |
| 53 |
(http://savannah.nongnu.org/projects/skencil/). |
project at Savannah |
| 54 |
|
(https://wald.intevation.org/projects/skencil/). |
| 55 |
|
|
| 56 |
The actual hosted html files are in Skencil's "Web Pages" CVS repository. |
The actual hosted html files are rsynced to Skencil's project website |
| 57 |
|
at wald. |
| 58 |
|
|
| 59 |
|
|
| 60 |
Building the Website |
Building the Website |
| 61 |
-------------------- |
-------------------- |
| 62 |
|
1. Checkout sources of the Skencil website. |
| 63 |
|
|
| 64 |
|
1.1 Simple way |
| 65 |
|
Most users might want to checkout the whole sources for the website |
| 66 |
|
regardless the fact that they might want to change only a small part |
| 67 |
|
of the site. |
| 68 |
|
|
| 69 |
|
* create a directory which will contain the sources |
| 70 |
|
* checkout the whole sources here using: |
| 71 |
|
|
| 72 |
|
svn checkout \ |
| 73 |
|
svn+ssh://[email protected]/skencil/website/trunk |
| 74 |
|
|
| 75 |
|
or for annonymous access: |
| 76 |
|
|
| 77 |
|
svn checkout |
| 78 |
|
https://scm.wald.intevation.org/svn/skencil/website/trunk |
| 79 |
|
|
| 80 |
|
1.2 Advanced way |
| 81 |
|
If you do not want to check out the whole site because you are about |
| 82 |
|
to change only a one page. You have the option to checkout only the |
| 83 |
|
files you need. So here is a short guide: |
| 84 |
|
|
| 85 |
|
* create a directory which will contain the sources. |
| 86 |
|
* enter this diretory. |
| 87 |
|
* checkout updatepages.py script here. |
| 88 |
|
* checkout the "modules" (pages,screenshots,gallery) you need. |
| 89 |
|
|
| 90 |
|
2. Generate html pages from the sources. |
| 91 |
|
Generation of the pages is done by the updatepages.py script. You will |
| 92 |
|
find it under the root folder of the source directory. |
| 93 |
|
You can control the behavior of the script providing some options. |
| 94 |
|
Please refer the build in help for more information. |
| 95 |
|
|
| 96 |
|
On default the website will be generated in a subfolder of your source |
| 97 |
|
directory named "skencil-website" but this is considered as |
| 98 |
|
depreciated. You should provide an alternative directory for the |
| 99 |
|
generated files with the -d option. |
| 100 |
|
|
| 101 |
|
3. Test your changes |
| 102 |
|
Check for all kind of errors. In example format and spelling errors. |
| 103 |
|
|
| 104 |
|
4. Checkin your changes |
| 105 |
|
To avoid conflicts that someone already changed the site at the same |
| 106 |
|
time, you should checkin your changes back to the repository. |
| 107 |
|
If there are no conflicts chances are very good that you won't mess up |
| 108 |
|
the site. |
| 109 |
|
|
| 110 |
|
5. Rsync generated files to make them public |
| 111 |
|
After successfull generation of the website you can rsync the |
| 112 |
|
generated files to the project website on wald. For general |
| 113 |
|
information on how to do this please refer: |
| 114 |
|
http://wald.intevation.org/docman/view.php/1/34/project-websites.txt |
| 115 |
|
|
| 116 |
|
Some examples: |
| 117 |
|
|
| 118 |
|
rsync a new index.html page to the server: |
| 119 |
|
rsync /path/to/my/generated/files/index.html \ |
| 120 |
|
[email protected]:/skencil/htdocs/ |
| 121 |
|
|
| 122 |
|
rsync your whole repository: |
| 123 |
|
rsync -r /path/to/my/generated/files/ \ |
| 124 |
|
[email protected]:/skencil/htdocs/ |
| 125 |
|
|
| 126 |
|
You might want to add the "-z" option on slow networks to compress the |
| 127 |
|
files before transmitting. For general help on rsync please refer the |
| 128 |
|
rsyn man page. |
| 129 |
|
|
|
Run "./updatepages.py" to update the web-pages in folder skencil/. |
|
|
(Use "--force" to create all of them regarding of the creation times.) |
|
|
If you also want to update Release Notes or the FAQ, you have to run the |
|
|
updatefaq and updaterelnotes.py scripts in folders faq/ and relnotes/ |
|
|
before you run updatepages.py. |
|
|
|
|
|
Gallery images can be built by running "make" in folder gallery/. Note |
|
|
that the gallery images require a lot of space for intermediate files; |
|
|
currently aroung 60MB. |
|
|
|
|
|
To upload the final html files to Savannah, just commit them to Skencil's |
|
|
"Web Pages" CVS repository. That can be achieved easily if "Web Pages" is |
|
|
checked out as skencil/ folder. |
|
Parent Directory
| 
Revision Log
| 
Patch