mirror of
https://github.com/php/web-doc.git
synced 2025-08-06 11:06:29 +00:00
Port article about manual builds from wiki
This commit is contained in:
34
tutorial/builds.md
Normal file
34
tutorial/builds.md
Normal file
@ -0,0 +1,34 @@
|
||||
# The PHP Manual builds
|
||||
|
||||
The PHP Manual is written in DocBook and built by PhD, and these builds are rsynced to the mirrors for users to use.
|
||||
|
||||
## Mirror builds
|
||||
The [rsync box](https://wiki.php.net/systems/sc1) builds the manuals each week, at 10:46 UTC on Fridays.
|
||||
The mirrors then pickup these builds when they sync, which usually happens every hour. When mirrors sync
|
||||
depends on how their cron is setup.
|
||||
|
||||
## Doc server builds
|
||||
The [documentation server](http://doc.php.net) builds and displays the manual four times daily (0:15 6:15 12:15
|
||||
and 18:15 UTC). This takes place on the [euk2](https://wiki.php.net/systems/euk2) server. The simplest way to see
|
||||
when each translation last built, see the [doc downloads page with dates](http://docs.php.net/download-docs.php?sizes=1).
|
||||
Also note that several old translations reside on this server, as it attempts to build every translation
|
||||
(both active and inactive).
|
||||
|
||||
## CHM builds
|
||||
The CHM version of the manual is built on a Windows machine and are pulled weekly on Fridays. Richard maintains
|
||||
these builds. Due to the security profile on the Windows machine, rsync is not used. Instead, a normal HTTP request
|
||||
is used.
|
||||
|
||||
## Validation
|
||||
Aside from running `php configure.php –with-lang=foo` for a language, another way to check if manuals validated is
|
||||
by looking at build dates on the doc server. See this list of [downloadable docs](http://docs.php.net/download-docs.php?sizes=1)
|
||||
for more information. These include the dates that the manual for each language successfully built.
|
||||
|
||||
## Additional notes
|
||||
- If a manual does not validate on Friday, it will not be pushed to the mirrors until hopefully the upcoming Friday.
|
||||
- Only active translations are selectable/downloadable, and this is managed in [phpweb/includes/languages.inc](http://git.php.net/?p=web/php.git;a=blob;f=include/languages.inc)
|
||||
|
||||
## The humans who manage these
|
||||
If there is a problem with the synced builds, it's wise to contact [Derick](http://people.php.net/derick) or
|
||||
[Hannes](http://people.php.net/bjori). If a problem exists on the developmental server (docs.php.net),
|
||||
then contact the documentation team.
|
@ -50,7 +50,7 @@ If you have access to SVN, you can commit modified files.
|
||||
## Viewing changes online
|
||||
Documentation is builded every Friday. It applies to all formats - online, offline HTML files and CHM. However,
|
||||
there is a special mirror - http://docs.php.net/ - where manual is updated from sources every six hours. If any
|
||||
errors occured, special message will be delivered to your mailinglist (`doc-{LANG}` for translations and `doc` for
|
||||
English manual).
|
||||
errors occured, special message will be delivered to your lang's mailinglist. Read more about manual builds in
|
||||
[dedicated appendix](builds.md).
|
||||
|
||||
Last chapter contains [style guidelines](style.md) you are obliged to follow. Read them carefully.
|
@ -18,9 +18,6 @@ Note: Usually the problem is a major XML syntax issue.
|
||||
## Is there an online editor?
|
||||
Yes, just go to https://edit.php.net
|
||||
|
||||
## How often is the documentation built?
|
||||
Weekly, but there is special mirror - https://doc.php.net - where documentation is build every six hours.
|
||||
|
||||
## How do I add a link to a method?
|
||||
Use `<methodname>Class::Method</methodname>` Note that the case does not matter when adding a link.
|
||||
|
||||
|
@ -22,6 +22,7 @@ format differs from the rest and it's called *pt_BR* for SVN module and *pt-br*
|
||||
|
||||
## Appendices
|
||||
- [FAQ](faq.md)
|
||||
- [PHP Manual builds](builds.md)
|
||||
|
||||
## Feedback
|
||||
Feedback is most certainly welcome on this document. Without your submissions and input, this document wouldn't exist.
|
||||
|
Reference in New Issue
Block a user