Building the docs site

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
(2. Become root, install Publican)
Line 24: Line 24:
 
gpgcheck=0</pre>
 
gpgcheck=0</pre>
  
==2. Become root, install Publican==
+
==2. Install Publican==
$ su -
+
$ sudo yum install publican publican-common-web
  
<nowiki>#</nowiki> yum install publican publican-common-web
+
[http://jfearn.fedorapeople.org/en-US/Publican/4.0/html/Users_Guide/chap-Publican-Users_Guide-Building_a_website_with_Publican.html#sect-Publican-Users_Guide-Building_a_website_with_Publican-Building_a_website_using_RPM_packages PUG 7.2.1, step 3] '''NB: package names out-of-date'''
  
[http://jfearn.fedorapeople.org/en-US/Publican/4.0/html/Users_Guide/chap-Publican-Users_Guide-Building_a_website_with_Publican.html#sect-Publican-Users_Guide-Building_a_website_with_Publican-Building_a_website_using_RPM_packages PUG 7.2.1, steps 2-3] '''NB: package names out-of-date'''
+
==3. Configure the website==
 +
$ sudo vi /etc/publican-website.cfg
 +
 
 +
For this test, I set:
 +
 
 +
<pre># where will the content be published to?
 +
toc_path: /var/www/html/docs
 +
# Where are the templates to build the TOCs?
 +
tmpl_path: /usr/share/publican/templates
 +
# Where is the database?
 +
db_file: /usr/share/publican/default.db
 +
title: "Fedora Documentation"
 +
search: <p/>
 +
dump: 1
 +
dump_file: /var/www/html/docs/DUMP.xml
 +
web_style: 2</pre>
 +
 
 +
The '''publican-website.cfg''' file used in production should have the ''host:'' parameter set too.
 +
 
 +
[http://jfearn.fedorapeople.org/en-US/Publican/4.0/html/Users_Guide/chap-Publican-Users_Guide-Building_a_website_with_Publican.html#sect-Publican-Users_Guide-Building_a_website_with_Publican-Building_a_website_using_RPM_packages PUG 7.2.1, step 4] '''NB: web_style parameter undocumented'''

Revision as of 03:42, 27 March 2014

This page describes the process to build the Publican-driven Fedora docs site, referencing the Publican 4.0 User Guide.

The site is based on an EL6 machine, pulling packages from the el6-docs repo in Koji.

Contents

0. Set up an el6 machine

For this test, I set up a fresh el6.5 machine.

1. Connect repos

1.1 optional subchannel

Activate the optional subchannel in RHN. Instructions here

1.2 EPEL

$ sudo yum localinstall http://mirror.as24220.net/pub/epel/6/i386/epel-release-6-8.noarch.rpm

1.3 el6-docs

Create /etc/yum.repos.d/el6-docs.repo with the following contents:

[el6-docs]
name=Packages for the Fedora docs site
baseurl=http://kojipkgs.fedoraproject.org/repos/el6-docs/latest/x86_64/
enabled=1
gpgcheck=0

2. Install Publican

$ sudo yum install publican publican-common-web

PUG 7.2.1, step 3 NB: package names out-of-date

3. Configure the website

$ sudo vi /etc/publican-website.cfg

For this test, I set:

# where will the content be published to?
toc_path: /var/www/html/docs
# Where are the templates to build the TOCs?
tmpl_path: /usr/share/publican/templates
# Where is the database?
db_file: /usr/share/publican/default.db
title: "Fedora Documentation"
search: <p/>
dump: 1
dump_file: /var/www/html/docs/DUMP.xml
web_style: 2

The publican-website.cfg file used in production should have the host: parameter set too.

PUG 7.2.1, step 4 NB: web_style parameter undocumented