From Fedora Project Wiki

Line 47: Line 47:
 
docs.fedoraproject.org would need to point to '''/var/www/html/docs''' on the server.
 
docs.fedoraproject.org would need to point to '''/var/www/html/docs''' on the server.
  
 +
<!--
 
====Staging site====
 
====Staging site====
 
Documentation also has a stage at http://docs.stg.fedoraproject.org. This host should also have Publican 2 running on it so that we can stage documents there that are not yet ready for even the "drafts" section of the main docs site. The most important use case would be the nightly builds of translated documentation that the Documentation project produces for the Localization project in the last few weeks before a release. Besides this, however, writers sometimes want to share extremely embryonic documentation. Being able to do this through the automated packaging system keeps even these early stages of development inside the main docs workflow.
 
Documentation also has a stage at http://docs.stg.fedoraproject.org. This host should also have Publican 2 running on it so that we can stage documents there that are not yet ready for even the "drafts" section of the main docs site. The most important use case would be the nightly builds of translated documentation that the Documentation project produces for the Localization project in the last few weeks before a release. Besides this, however, writers sometimes want to share extremely embryonic documentation. Being able to do this through the automated packaging system keeps even these early stages of development inside the main docs workflow.
Line 52: Line 53:
 
===Set up Koji for documents===
 
===Set up Koji for documents===
 
We would need a target/tag for dist-6E-docs and perms for docs project members to build in there
 
We would need a target/tag for dist-6E-docs and perms for docs project members to build in there
 
+
-->
  
 
[[Category:Docs Project]]
 
[[Category:Docs Project]]

Revision as of 00:24, 22 January 2014

This page tracks progress towards implementing a fully automated publishing process for the Fedora Documentation Project.

Background

Formal Fedora documentation is authored in DocBook XML and transformed into multi-page HTML, single-page HTML, PDF, and EPUB by our publishing tool, Publican. Publican also maintains the Fedora documentation site (docs.fedoraproject.org) and automatically generates and updates the navigation menus in each language.

At present, the entire documentation suite hosted at http://docs.fedoraproject.org resides in a Git repository to which certain members of the Documentation Project (members of the docs-publishers group) commit changes. The webserver publishes whatever is in that repo.

This is a vast improvement over our previous process, but Publican includes features that make publishing even easier and more robust, since Publican is designed to package documentation in RPM packages to install on a webserver. Chapter 6 of the Publican Users' Guide provides an overview of the mechanism.

Important -- note that since the webserver runs Red Hat Enterprise Linux 6, the documentation packages need to be built for Red Hat Enterprise Linux 6. Publican is also designed to build documentation to install for desktop use, but this is a separate set of considerations and not the aim here.

Steps to automate publishing

Install Publican 4.0 on the webserver

The version of Publican shipped in Red Hat Enterprise Linux 6 is very old (2.1) and lacks many bug fixes and enhancements that have been added since then (current upstream is 4.0, due in Fedora in the next few weeks).

Some of the Publican 4.0 deps in Red Hat Enterprise Linux 6 are too old or not available on all arches; we will need to build these for el6-docs

It's also possible that Publican 4.0 has dependencies that are not in Red Hat Enterprise Linux 6; at all. If so, we will need to add these to EPEL.

To install Publican 4.0 on the webserver, we need to

  • get a new el6-docs build root -- rel-eng request here Done! Thanks ausil!
  • identify and build any dependencies not in el6 for EPEL
  • identify and build any dependencies too old or not on all arches in el6 for el6-docs.
  • build Publican 4.0 and the Fedora brand package for el6-docs.

Dependencies not in el6

  • wkhtmltopdf
    • wkhtmltopdf-qt

Dependencies to update in el6

  • perl-DateTime-Format-DateParse -- not shipped for PPC64
  • perl-HTML-Tree -- too old
    • perl-XML-TreeBuilder -- too old


Configure an Publican-generated website on the webserver

Publican can automatically generate its own website structure on the server. This consists of:

  • a configuration file at /etc/publican-website.cfg
  • an SQLite database at /var/lib/publican/publican-website.db
  • the /var/www/html/docs directory in which Publican publishes documentation

docs.fedoraproject.org would need to point to /var/www/html/docs on the server.
https://www.fedoraproject.org/w/index.php?title=Automating_publishing&diff=prev&oldid=367784
www.fedoraproject.org
crawl=CC-MAIN-2021-17
26530
application/http; msgtype=response
sha1:XU3I3N3CEK55RI4DDEGZ57QZVAWJC26C
<urn:uuid:7517b886-a13c-4980-9294-e77ac9d18b5e>
2021-04-18T09:27:46Z
140.211.169.196
text/html
sha1:3Q3R5SWXTXL27J3ILV7L4SICYO7CU4AC
<urn:uuid:20253ea8-b510-46bc-a17d-9ed8563dbbc4>
https://www.fedoraproject.org/w/index.php?title=Automating_publishing&diff=prev&oldid=367784
response
<urn:uuid:fbcb168e-06e3-4d86-bceb-02bfe7fd18b0>
isPartOf: CC-MAIN-2021-17
publisher: Common Crawl
description: Wide crawl of the web for April 2021
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-90.ec2.internal
software: Apache Nutch 1.18 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.2-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: https://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/