minor updates to tutorial builds page

mirrors -> web servers
build schedules
add Peter as point of contact for docs.php.net
link to phpdoc list
This commit is contained in:
Peter Cowburn
2019-04-01 21:43:33 +01:00
parent 5909e1b832
commit eb5f58c55b

View File

@ -1,16 +1,15 @@
# The PHP Manual builds # The PHP Manual builds
The PHP Manual is written in [DocBook][docbook] and built by [PhD][phd], and The PHP Manual is written in [DocBook][docbook] and built by [PhD][phd], and
these builds are rsynced to the mirrors for users to use. these builds are rsynced to the web servers for users to use.
## Mirror builds ## Mirror builds
The [rsync box][rsync.php.net] builds the manuals every night, at around 5:00 UTC. The [rsync box][rsync.php.net] builds the manuals every night, at around 05:00 UTC.
The mirrors then pick up these builds when they sync, which usually happens every hour. The web servers then pick up these builds when they sync, which usually happens every hour.
When a mirror syncs depends on how its cron is set up.
## Doc server builds ## Doc server builds
The [docs development server][docs.php.net] builds the manual four times a day The [docs development server][docs.php.net] builds the manual six times a day
(0:15 6:15 12:15 and 18:15 UTC). This takes place on the [euk2][euk2] server. (every 4 hours, starting at midnight UTC). This takes place on the [euk2][euk2] server.
An easy way to see when each translation was last built, is to look at the An easy way to see when each translation was last built, is to look at the
[doc downloads page with dates][download-docs]. Also note that several old [doc downloads page with dates][download-docs]. Also note that several old
translations reside on this particular server, as it attempts to build every translations reside on this particular server, as it attempts to build every
@ -18,7 +17,7 @@ translation (both active and inactive).
## CHM builds ## CHM builds
The CHM version of the manual is built on a Windows machine and pulled on Fridays, The CHM version of the manual is built on a Windows machine and pulled on Fridays,
for distribution to mirrors. [Richard][rquadling] maintains these builds. for distribution to web servers. [Richard][rquadling] maintains these builds.
## Validation ## Validation
Aside from running `php configure.php with-lang=foo` (see [editing](editing.php)) Aside from running `php configure.php with-lang=foo` (see [editing](editing.php))
@ -26,22 +25,20 @@ for a language, another way to check if the docs validated is by looking at buil
dates on the doc server. See "Doc server builds", above. dates on the doc server. See "Doc server builds", above.
## Additional notes ## Additional notes
- If a manual does not validate on some day, it will not be pushed to the mirrors - If a manual does not validate on some day, it will not be pushed to the web servers
until it does validate (hopefully, the next day). until it does validate (hopefully, the next day).
- Only active translations are built on rsync box (and then pushed to regular - Only active translations are built on rsync box (and then pushed to regular
mirrors). This is managed in [web/php/includes/languages.inc][languages.inc] mirrors). This is managed in [web/php/includes/languages.inc][languages.inc]
- [docs.php.net][docs.php.net] attempts to build all translations (both active) - [docs.php.net][docs.php.net] attempts to build all translations (both active
and inactive. and inactive). However, we use a `broken-language.txt` file in root of broken
translations to disable those that are very outdated and failing to build
However, we use `broken-language.txt` file in root of broken
translations to disable those very outdated and failing to build
for a long time. for a long time.
## The humans who manage these ## The humans who manage these
If there is a problem with the synced builds, it's wise to contact If there is a problem with the synced builds, it's wise to contact
[Derick][derick] or [Hannes][bjori]. [Derick][derick] or [Hannes][bjori].
If a problem exists on the development server ([docs.php.net][docs.php.net]), If a problem exists on the development server ([docs.php.net][docs.php.net]),
then contact the documentation team. then contact [Peter][salathe] or the [documentation team mailing list][phpdoc-list].
[docbook]: http://www.docbook.org/ [docbook]: http://www.docbook.org/
[phd]: http://doc.php.net/phd.php [phd]: http://doc.php.net/phd.php
@ -54,3 +51,5 @@ then contact the documentation team.
[rquadling]: http://people.php.net/rquadling [rquadling]: http://people.php.net/rquadling
[derick]: http://people.php.net/derick [derick]: http://people.php.net/derick
[bjori]: http://people.php.net/bjori [bjori]: http://people.php.net/bjori
[salathe]: http://people.php.net/salathe
[phpdoc-list]: mailto:phpdoc@lists.php.net