PageRenderTime 34ms CodeModel.GetById 30ms app.highlight 2ms RepoModel.GetById 1ms app.codeStats 0ms

/README.md

http://github.com/perlorg/cpanorg
Markdown | 53 lines | 36 code | 17 blank | 0 comment | 0 complexity | 0900d88fdac4f254cf7b985ccbdae8fa MD5 | raw file
 1# CPAN.org content repository
 2
 3This repository is for maintaining the non-source-code, non-archive
 4content on cpan.org.  Discussion related to this should be on the
 5[cpan-workers mailing list][cpan-workers].
 6
 7[cpan-workers]: http://lists.perl.org/list/cpan-workers.html
 8
 9## Rules for editing content:
10
11* Don't add new output files. Only files already on cpan.org should be
12added (and then to their current location). Generally email
13ask@perl.org to get new files included here. Making new
14templates/scripts/etc to produce the output files is fine.
15
16* Be conservative in your edits.  While lots of updates are needed,
17this has been around for 20 years and will be for many more. There's
18no rush.
19
20* No style edits for now. Cleanups yes; but a new design/layout will
21wait.
22
23## How to submit changes
24
25A 'pull request' on github is the best way. Sending a patch to the
26cpan-workers list at the same time will be a good way to get peer
27review. A change with a few "+1" votes from the list are more likely
28to be expediently pulled in.
29
30## How it works
31
32Install Template Toolkit and the other requirements with `cpanm` by running `make install`.
33
34To fetch the data needed for the site, run `make update-data update-daily`.
35
36Then run `make`. This will in turn run `ttree` and generate output
37files in the html/ directory.
38
39Image files are copied plainly to the html/ directory.
40
41Everything else is processed through template toolkit. Only .html
42files get the "master template" applied automatically.
43
44## Run under docker
45
46Experimental, you can build the content from theses templates with:
47
48    mkdir -p root/tmp root/CPAN
49    docker run --rm -ti \
50      -v `pwd`:/cpan/content -v `pwd`/root:/cpan \
51      -w /cpan/content \
52      quay.io/perl/cpanorg:master \
53        make build update-data update-master