source: project/gazette/README.txt @ 21944

Last change on this file since 21944 was 21518, checked in by Moritz Heidkamp, 10 years ago

gazette: include vandusen-gazette information in README

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