Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 45 lines (28 sloc) 1.494 kB
4565501 @abh basic readme
abh authored
1 # CPAN.org content repository
2
3 This repository is for maintaining the non-source-code, non-archive
4 content on cpan.org. Discussion related to this should be on the
7870784 @abh minor cleanup
abh authored
5 [cpan-workers mailing list][cpan-workers].
6
7 [cpan-workers]: http://lists.perl.org/list/cpan-workers.html
4565501 @abh basic readme
abh authored
8
9 ## Rules for editing content:
10
c86e360 @abh Clarify the "new files" thing
abh authored
11 * Don't add new output files. Only files already on cpan.org should be
12 added (and then to their current location). Generally email
13 ask@perl.org to get new files included here. Making new
14 templates/scripts/etc to produce the output files is fine.
4565501 @abh basic readme
abh authored
15
16 * Be conservative in your edits. While lots of updates are needed,
17 this has been around for 15 years and will be for many more. There's
18 no rush.
19
20 * No style edits for now. Cleanups yes; but a new design/layout will
21 wait.
22
23 ## How to submit changes
24
25 A 'pull request' on github is the best way. Sending a patch to the
26 cpan-workers list at the same time will be a good way to get peer
27 review. A change with a few "+1" votes from the list are more likely
28 to be expediently pulled in.
29
30 ## How it works
31
2e5fd2e @abh Small tweaks to the RSS downloader
abh authored
32 Install Template Toolkit and the other requirements with `cpanm` by running `make install`.
33
171bb4c @ranguard Minor copy cleanup
ranguard authored
34 To fetch the data needed for the site, run `make update-data update-daily`.
eb807a4 @abh Just fetch the perl releases a few times a day
abh authored
35
2e5fd2e @abh Small tweaks to the RSS downloader
abh authored
36 Then run `make`. This will in turn run `ttree` and generate output
37 files in the html/ directory.
4565501 @abh basic readme
abh authored
38
39 Image files are copied plainly to the html/ directory.
40
41 Everything else is processed through template toolkit. Only .html
42 files get the "master template" applied automatically.
43
44
Something went wrong with that request. Please try again.