Skip to content

Commit

Permalink
Pull out info on the docs.perl6.org build
Browse files Browse the repository at this point in the history
  • Loading branch information
coke committed Mar 27, 2018
1 parent 923fa1a commit 4959b90
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 21 deletions.
17 changes: 17 additions & 0 deletions BUILD.md
@@ -0,0 +1,17 @@
# htmlify.p overview

For syntax highlighting, needs node.js installed.
Please run make init-highlights to automatically pull in the highlighting
grammar and build the highlighter.

For doc.perl6.org, the build process goes like this:
a cron job on hack.p6c.org as user 'doc.perl6.org' triggers the rebuild.

*/5 * * * * flock -n ~/update.lock -c ./doc/util/update-and-sync > update.log 2>&1

`util/update-and-sync` is under version control in the perl6/doc repo (same as
this file), and it first updates the git repository. If something changed, it
runs htmlify, captures the output, and on success, syncs both the generated
files and the logs. In case of failure, only the logs are synchronized.

The build logs are available at https://docs.perl6.org/build-log/
21 changes: 0 additions & 21 deletions htmlify.p6
@@ -1,27 +1,6 @@
#!/usr/bin/env perl6
use v6.c;

=begin overview
This script isn't in bin/ because it's not meant to be installed.
For syntax highlighting, needs node.js installed.
Please run C<make init-highlights> to automatically pull in the highlighting
grammar and build the highlighter.
For doc.perl6.org, the build process goes like this:
a cron job on hack.p6c.org as user 'doc.perl6.org' triggers the rebuild.
*/5 * * * * flock -n ~/update.lock -c ./doc/util/update-and-sync > update.log 2>&1
C<util/update-and-sync> is under version control in the perl6/doc repo (same as
this file), and it first updates the git repository. If something changed, it
runs htmlify, captures the output, and on success, syncs both the generated
files and the logs. In case of failure, only the logs are synchronized.
The build logs are available at https://docs.perl6.org/build-log/
=end overview

BEGIN say 'Initializing ...';

use lib 'lib';
Expand Down

0 comments on commit 4959b90

Please sign in to comment.