| Firebird Documentation Index → Firebird Docbuilding Howto |
|
|
|
Table of Contents
This Howto explains, step by step, how you can download and build the firebird-documentation repository from the Firebird Project.
The firebird-documentation repository is part of the Firebird Project on GitHub: https://github.com/FirebirdSQL/firebird-documentation. It is a collective effort, aimed at producing comprehensive and accurate documentation on the Firebird RDBMS (Relational Database Management System).
It is important to understand that the firebird-documentation repository contains the documentation in source form – to be more precise: in DocBook XML format. These sources need to be processed (built) to obtain easily readable docs, which can then be published on the Internet.
Yes! At the time of this writing, most useful Firebird documentation has been produced outside the Firebird documentation repository. We still have a long way to go before the documentation in the manual module will be anywhere near complete. In fact, one of the reasons this Howto is written is that it can help would-be docwriters to overcome their first hurdles.
If you are looking for ready Firebird documentation and lots of it, your best starting places are:
https://www.firebirdsql.org/en/documentation/ – the Firebird Documentation Index.
https://www.firebirdsql.org/en/external-documentation/ – a listing of other sites with valuable Firebird documentation.
Sure there's an easier way. As soon as a piece of documentation reaches a certain level of maturity, it is published – in PDF and HTML – on the Firebird website. You can find all the docs we have published via the Firebird Documentation Index (see link above).
You should download the manual module and build the docs yourself if and only if:
You want to check on the absolutely latest state of the docs. (Be aware though that one of the reasons a version has not yet been published may be that it contains errors.)
You want to help write documentation yourself.
You're interested in learning how this doc building stuff works, and/or you think DIY is more fun than an easy file download.
If one of the above applies to your situation, this Howto is for you.
|
| Firebird Documentation Index → Firebird Docbuilding Howto |