| 1 | |
|---|
| 2 | --== The Chicken Gazette ==-- |
|---|
| 3 | --== Guide for Authors ==-- |
|---|
| 4 | |
|---|
| 5 | |
|---|
| 6 | Thank you for volunteering to produce an issue of the Chicken Gazette! |
|---|
| 7 | |
|---|
| 8 | This guide aims to explain how it's done. |
|---|
| 9 | |
|---|
| 10 | 0) Check out the Gazette: |
|---|
| 11 | |
|---|
| 12 | svn checkout https://code.call-cc.org/svn/chicken-eggs/gazette |
|---|
| 13 | |
|---|
| 14 | 1) Create a new issue in src/issues. Take the largest number in there, |
|---|
| 15 | add one, and stick ".wiki" on the end of the name. It's probably a |
|---|
| 16 | good idea to copy the previous issue file, so you have the right |
|---|
| 17 | template to start with. |
|---|
| 18 | |
|---|
| 19 | 2) Update the (date . <number>) header, perhaps by adding 604800 (the |
|---|
| 20 | number of seconds in a week) to it. |
|---|
| 21 | |
|---|
| 22 | 3) Write thrilling content. To find out the past week's egg and core |
|---|
| 23 | commits, visit: |
|---|
| 24 | |
|---|
| 25 | http://bugs.call-cc.org/timeline?daysback=10&changeset=on |
|---|
| 26 | |
|---|
| 27 | http://bugs.call-cc.org/log/release/4/egg-locations |
|---|
| 28 | |
|---|
| 29 | http://code.call-cc.org/cgi-bin/gitweb.cgi?p=chicken-core.git;a=heads |
|---|
| 30 | |
|---|
| 31 | The latest Salmonella report can be viewed at: |
|---|
| 32 | |
|---|
| 33 | http://tests.call-cc.org/current/salmonella-report/ |
|---|
| 34 | |
|---|
| 35 | But to link to it, please form a permalink to the archive for that |
|---|
| 36 | day, like so: |
|---|
| 37 | |
|---|
| 38 | http://tests.call-cc.org/2010/09/10/salmonella-report/ |
|---|
| 39 | |
|---|
| 40 | Check out the list archives at: |
|---|
| 41 | |
|---|
| 42 | http://www.mail-archive.com/chicken-users@nongnu.org |
|---|
| 43 | http://www.mail-archive.com/chicken-hackers@nongnu.org/ |
|---|
| 44 | |
|---|
| 45 | http://lists.nongnu.org/archive/html/chicken-users/ |
|---|
| 46 | http://lists.nongnu.org/archive/html/chicken-hackers/ |
|---|
| 47 | |
|---|
| 48 | ...and link directly to messages there. |
|---|
| 49 | |
|---|
| 50 | You can also use the scripts on the gazette wiki page to help you decide what to |
|---|
| 51 | write about: |
|---|
| 52 | |
|---|
| 53 | http://wiki.call-cc.org/gazette#the-crazy-gazette-automation-plan |
|---|
| 54 | |
|---|
| 55 | When you mention people's names, link to their wiki page if they have |
|---|
| 56 | one. The list is at: |
|---|
| 57 | |
|---|
| 58 | http://wiki.call-cc.org/users |
|---|
| 59 | |
|---|
| 60 | Another source of information is our IRC bot vandusen in the #chicken |
|---|
| 61 | channel on freenode. Channel regulars try to record interesting bits |
|---|
| 62 | in the course of a week for the next Gazette. To get a list of what |
|---|
| 63 | has been recorded, just say "vandusen: gazette" in the channel and |
|---|
| 64 | you'll be sent the information by vandusen. |
|---|
| 65 | |
|---|
| 66 | Recording information works through the "gazette" command, as well. To |
|---|
| 67 | create a reference to interesting commits (like tags), call it like |
|---|
| 68 | "vandusen: gazette r123" or optionally with an additional note: |
|---|
| 69 | "vandusen: gazette r123 Joe Schmoe tagged super-duper-sql 1.2, introducing magic auto-quoting!". |
|---|
| 70 | However, you don't have to reference a commit to record a note. |
|---|
| 71 | |
|---|
| 72 | 4) Commit whenever you want. The contents of SVN aren't made live |
|---|
| 73 | automatically, so feel free to commit your drafts. You may need to ask |
|---|
| 74 | Mario to give you commit access to |
|---|
| 75 | https://code.call-cc.org/svn/chicken-eggs/gazette if it doesn't work |
|---|
| 76 | at first. |
|---|
| 77 | |
|---|
| 78 | 5) Preview your work by installing hyde and running "hyde serve" from |
|---|
| 79 | the top-level gazette directory, then visiting |
|---|
| 80 | http://localhost:8080/. Your new episode should appear on the front |
|---|
| 81 | page by default; if it doesn't, make sure you've set the date header |
|---|
| 82 | on the page correctly! |
|---|
| 83 | |
|---|
| 84 | 6) Prepare a plain text version by running issue2mail.scm. The result |
|---|
| 85 | will need some manual work to make it look right. Removing links is |
|---|
| 86 | often a good step. The way to run issue2mail.scm is: |
|---|
| 87 | |
|---|
| 88 | csi -script issue2mail.scm src/issues/<number>.wiki > issue.txt |
|---|
| 89 | |
|---|
| 90 | 7) When you think it's ready, commit it and announce in #chicken on |
|---|
| 91 | Freenode so that the experts can proofread it and suggest any improvements. |
|---|
| 92 | |
|---|
| 93 | 8) When it's REALLY ready, tell DerGuteMoritz in IRC / Moritz Heidkamp to |
|---|
| 94 | roll it out to the site, and email the plain text version to |
|---|
| 95 | chicken-users@nongnu.org |
|---|
| 96 | |
|---|
| 97 | If Moritz is unavailable and you have a user account on call-cc.org, |
|---|
| 98 | you can checkout https://code.call-cc.org/svn/chicken-eggs/gazette and |
|---|
| 99 | just run these commands: |
|---|
| 100 | |
|---|
| 101 | umask u=rw,g=rw,o=r |
|---|
| 102 | /usr/local/chickens/chicken-gazette/bin/hyde -e live |
|---|
| 103 | |
|---|
| 104 | The Gazette should then be published on gazette.call-cc.org! |
|---|
| 105 | |
|---|
| 106 | 9) Thanks! |
|---|