source: project/gazette/README.txt

Last change on this file was 25561, checked in by mario, 7 years ago

gazette/README.txt: added umask command for publishing

File size: 3.8 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://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
31The latest Salmonella report can be viewed at:
32
33    http://tests.call-cc.org/current/salmonella-report/
34
35But to link to it, please form a permalink to the archive for that
36day, like so:
37
38     http://tests.call-cc.org/2010/09/10/salmonella-report/
39
40Check 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
50You can also use the scripts on the gazette wiki page to help you decide what to
51write about:
52
53     http://wiki.call-cc.org/gazette#the-crazy-gazette-automation-plan
54
55When you mention people's names, link to their wiki page if they have
56one. The list is at:
57
58     http://wiki.call-cc.org/users
59
60Another source of information is our IRC bot vandusen in the #chicken
61channel on freenode. Channel regulars try to record interesting bits
62in the course of a week for the next Gazette. To get a list of what
63has been recorded, just say "vandusen: gazette" in the channel and
64you'll be sent the information by vandusen.
65
66Recording information works through the "gazette" command, as well. To
67create 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!".
70However, you don't have to reference a commit to record a note.
71
724) Commit whenever you want. The contents of SVN aren't made live
73automatically, so feel free to commit your drafts. You may need to ask
74Mario to give you commit access to
75https://code.call-cc.org/svn/chicken-eggs/gazette if it doesn't work
76at first.
77
785) Preview your work by installing hyde and running "hyde serve" from
79the top-level gazette directory, then visiting
80http://localhost:8080/. Your new episode should appear on the front
81page by default; if it doesn't, make sure you've set the date header
82on the page correctly!
83
846) Prepare a plain text version by running issue2mail.scm. The result
85will need some manual work to make it look right. Removing links is
86often a good step. The way to run issue2mail.scm is:
87
88      csi -script issue2mail.scm src/issues/<number>.wiki > issue.txt
89
907) When you think it's ready, commit it and announce in #chicken on
91Freenode so that the experts can proofread it and suggest any improvements.
92
938) When it's REALLY ready, tell DerGuteMoritz in IRC / Moritz Heidkamp to
94roll it out to the site, and email the plain text version to
95chicken-users@nongnu.org
96
97If Moritz is unavailable and you have a user account on call-cc.org,
98you can checkout https://code.call-cc.org/svn/chicken-eggs/gazette and
99just run these commands:
100
101  umask u=rw,g=rw,o=r
102  /usr/local/chickens/chicken-gazette/bin/hyde -e live
103
104The Gazette should then be published on gazette.call-cc.org!
105
1069) Thanks!
Note: See TracBrowser for help on using the repository browser.