|
Size: 1503
Comment:
|
Size: 4510
Comment: Adding link to kondo docs
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| Kinda sucks. | Kinda sucks. We have people fixing it. |
| Line 5: | Line 5: |
| It's not just webmasters than can write things to go on the website! E-mail it to us and we'll upload it, and you can apply for membership of webmasters simply by e-mailing the list or by bullying a nearby Wheel member. | It's not just webmasters than can write things to go on the website! E-mail it to us and we'll upload it, and you can apply for membership of webmasters simply by e-mailing the list or by bullying a nearby Wheel member. If you don't want to be a webmaster but do want to add content to the site, the best format to send us the content in is plain text. == Editing == To edit a page on the UCC website, you need to first be in the webmasters group (www-data). Files are located in /services/http. Next edit the .ucc file for the page you want to edit (NOT the .html, it is dynamically generated from the .ucc file). Check the .html page has updated after changing the .ucc file, sometimes it likes to mess around with your head - you may even have to delete the .html file to force it to update. == ucc-parser == See docs on the ucc-parser Kondo here: https://ucc.asn.au/kondo/ .ucc files are handled by Apache using its Handlers system. The critical lines occur in {{{/etc/apache2/sites-available/default}}} and are as follows: {{{ Action ucc-parsed /cgi-bin/ucc-parser AddHandler ucc-parsed .ucc }}} It should also be noted that {{{/etc/apache2/sites-available/default}}} should be configured so as to have {{{index.ucc}}} be the default index file, that is: {{{ DirectoryIndex index.ucc index.html index... }}} In addition, any conflicting {{{DirectoryIndex}}} entries (such as that in {{{/etc/apache2/mods-available/dir.conf}}}) should be dealt with accordingly (in the case of {{{dir.conf}}}, the line can simply be commented out). <<BR>>This section written 2013-11-07. Knowing UCC this will remain long after it is made invalid. === DOCTYPE grahame === Some .ucc files are actually XML files using the 'grahame' DOCTYPE, others are written in [[http://daringfireball.net/projects/markdown/|Markdown]], and both are parsed by the XSL Template `/services/http/.build/xhtml11.xsl` to become the webpage that the user sees. If you are feeling masochistic you are free to read the xsl file to try and understand the format used, but reading the existing pages is easier. In the interests of future compatability and upgrades, try and use markdown instead of DOCTYPE grahame, it's much more portable. === Analytics === So that we can keep track of things, google analytics code has been added to the core pages of the site by modifying `/services/http/.build/xhtml11.xsl`. There are also plans to add google analytics to the wiki. For more information and access to the analytics, speak to Matt Didcoe, who has clue. === A note on permissions === There are a number of files that webmasters can not access, mostly because there is no need. Here is a short list to save you a lot of time and sanity: anything to do with 'planet ucc' and its associated styles, and any of the wiki config/theme files. Luckily for you, these files are segregated from the rest of the site and the need to change them is very rare. |
| Line 12: | Line 42: |
| * SVN/CVS? include ViewCVS at [http://cvs.ucc.asn.au/] - monotone too. DRAFT at http://ucc.asn.au/services/vcs.ucc * IRC server [irc://mussel.ucc.gu.uwa.edu.au/#ucc] |
* SVN/CVS? include ViewCVS at [[http://cvs.ucc.asn.au/]] - monotone too. DRAFT at http://ucc.asn.au/services/vcs.ucc * IRC server [[irc://mussel.ucc.gu.uwa.edu.au/#ucc]] - well we have a page at irc.ucc, but it needs to be less 'policy' and more 'how-to' |
| Line 19: | Line 49: |
| * FAQ - incorrect and largely redundant | * FAQ - incorrect and largely redundant "I vote we just get rid of it, we have so many questions that we need a wiki, not an FAQ [BOB]" |
| Line 23: | Line 53: |
| * snack.ucc - oh man * news.ucc - needs about four more lines to make it useful |
* snack.ucc - needs some new pics, and updating * news.ucc - needs about four more lines to make it useful "I think this is redundant, orphaned, and out of date for a reason - nobody uses it. I vote we delete it [BOB]" |
| Line 28: | Line 58: |
| === Machines === * Sporadically updated with information or new machines, but in general is pretty out of date |
Anything on the OrphanedPages list probably needs some work and better incorporating into the site. |
| Line 31: | Line 60: |
| === Projects === * Requires first actually having projects === Sponsors === * Anti-sponsorship page? |
---- CategoryProjects CategoryProjectsOngoing |
The UCC Website
Kinda sucks. We have people fixing it.
It's not just webmasters than can write things to go on the website! E-mail it to us and we'll upload it, and you can apply for membership of webmasters simply by e-mailing the list or by bullying a nearby Wheel member. If you don't want to be a webmaster but do want to add content to the site, the best format to send us the content in is plain text.
Editing
To edit a page on the UCC website, you need to first be in the webmasters group (www-data). Files are located in /services/http. Next edit the .ucc file for the page you want to edit (NOT the .html, it is dynamically generated from the .ucc file). Check the .html page has updated after changing the .ucc file, sometimes it likes to mess around with your head - you may even have to delete the .html file to force it to update.
ucc-parser
See docs on the ucc-parser Kondo here: https://ucc.asn.au/kondo/
.ucc files are handled by Apache using its Handlers system. The critical lines occur in /etc/apache2/sites-available/default and are as follows:
Action ucc-parsed /cgi-bin/ucc-parser AddHandler ucc-parsed .ucc
It should also be noted that /etc/apache2/sites-available/default should be configured so as to have index.ucc be the default index file, that is:
DirectoryIndex index.ucc index.html index...
In addition, any conflicting DirectoryIndex entries (such as that in /etc/apache2/mods-available/dir.conf) should be dealt with accordingly (in the case of dir.conf, the line can simply be commented out).
This section written 2013-11-07. Knowing UCC this will remain long after it is made invalid.
DOCTYPE grahame
Some .ucc files are actually XML files using the 'grahame' DOCTYPE, others are written in Markdown, and both are parsed by the XSL Template /services/http/.build/xhtml11.xsl to become the webpage that the user sees. If you are feeling masochistic you are free to read the xsl file to try and understand the format used, but reading the existing pages is easier. In the interests of future compatability and upgrades, try and use markdown instead of DOCTYPE grahame, it's much more portable.
Analytics
So that we can keep track of things, google analytics code has been added to the core pages of the site by modifying /services/http/.build/xhtml11.xsl. There are also plans to add google analytics to the wiki. For more information and access to the analytics, speak to Matt Didcoe, who has clue.
A note on permissions
There are a number of files that webmasters can not access, mostly because there is no need. Here is a short list to save you a lot of time and sanity: anything to do with 'planet ucc' and its associated styles, and any of the wiki config/theme files. Luckily for you, these files are segregated from the rest of the site and the need to change them is very rare.
Pages that should be written
Services
- Wireless
- PPTP
SVN/CVS? include ViewCVS at http://cvs.ucc.asn.au/ - monotone too. DRAFT at http://ucc.asn.au/services/vcs.ucc
IRC server irc://mussel.ucc.gu.uwa.edu.au/#ucc - well we have a page at irc.ucc, but it needs to be less 'policy' and more 'how-to'
PostgreSQL/MySQL? these are actually useful if you know about them. There's also several installations, up to one per machine - should consolidate if appropriate. DRAFT at http://ucc.asn.au/services/sql.ucc
Pages that need updating
Infobase
- FAQ - incorrect and largely redundant "I vote we just get rid of it, we have so many questions that we need a wiki, not an FAQ [BOB]"
- Newsletters - someone upload the 06 Murphy's Lore?
Services
- snack.ucc - needs some new pics, and updating
- news.ucc - needs about four more lines to make it useful "I think this is redundant, orphaned, and out of date for a reason - nobody uses it. I vote we delete it [BOB]"
- web.ucc - ucc-adduser creates web directories these days, add info about the proxying we do, how you can't use .htaccess to do IP filtering without mod_rewrite, why to not rely on HTTP_CLIENT_IP or whatever the header is, etc.
- ftp.ucc - probably needs reworking for SFTP or deleting entirely
Anything on the OrphanedPages list probably needs some work and better incorporating into the site.
