pgbackrest/doc/xml/user-guide-index.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE doc SYSTEM "doc.dtd">
<doc title="{[project]}" subtitle="User Guides" toc="n">
    <description>List of available {[project]} user guides.</description>

    <!-- ======================================================================================================================= -->
    <section id="index">
        <title>Available User Guides</title>

        <list>
            <list-item><link url="user-guide.html">{[os-debian-title]}</link></list-item>
            <list-item><link url="user-guide-rhel.html">{[os-rhel-title]}</link></list-item>
        </list>
    </section>
</doc>
Add user guides for CentOS/RHEL 6/7. It would be better if the documentation could be generated on multiple operating systems all in one go, but the doc system currently does not allow vars to be changed once they are set. The solution is to run the docs for each required OS and stitch the documentation together. It's not pretty but it works and the automation in release.pl should at least make it easy to use. 2019-05-16 14:32:02 +02:00			`<?xml version="1.0" encoding="UTF-8"?>`
			`<!DOCTYPE doc SYSTEM "doc.dtd">`
			`<doc title="{[project]}" subtitle="User Guides" toc="n">`
			`<description>List of available {[project]} user guides.</description>`

Clean up dividers in the documentation. Dividers were used in some files, but not others, and some had section names (which are hard to maintain) and others did not. Try to make this more consistent by putting a divider on front of every section, variable block, and wherever else seems appropriate. 2022-05-06 18:11:04 +02:00			`<!-- ======================================================================================================================= -->`
Add user guides for CentOS/RHEL 6/7. It would be better if the documentation could be generated on multiple operating systems all in one go, but the doc system currently does not allow vars to be changed once they are set. The solution is to run the docs for each required OS and stitch the documentation together. It's not pretty but it works and the automation in release.pl should at least make it easy to use. 2019-05-16 14:32:02 +02:00			`<section id="index">`
			`<title>Available User Guides</title>`

			`<list>`
Simplify messaging around supported versions in the documentation. The version ranges given in the user guides caused confusion. For example, because the user guide for RHEL specified PostgreSQL 9.6-11, users questioned whether pgBackRest worked for PostgreSQL 12 on RHEL. Remove these ranges and add more explanatory text to the introduction to try and make it clearer how the user guides work and which versions are covered (basically all of them). 2022-05-09 17:59:08 +02:00			`<list-item><link url="user-guide.html">{[os-debian-title]}</link></list-item>`
			`<list-item><link url="user-guide-rhel.html">{[os-rhel-title]}</link></list-item>`
Add user guides for CentOS/RHEL 6/7. It would be better if the documentation could be generated on multiple operating systems all in one go, but the doc system currently does not allow vars to be changed once they are set. The solution is to run the docs for each required OS and stitch the documentation together. It's not pretty but it works and the automation in release.pl should at least make it easy to use. 2019-05-16 14:32:02 +02:00			`</list>`
			`</section>`
			`</doc>`