Bug 1123193

Summary: RFE: link to external links on splash pages
Product: [Community] Publican Reporter: Ruediger Landmann <rlandman>
Component: publicanAssignee: Jeff Fearn 🐞 <jfearn>
Status: CLOSED CURRENTRELEASE QA Contact: Summer Long <slong>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: futureCC: aigao, ddomingo, rlandman, slong
Target Milestone: 4.2   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Fixed In Version: 4.2.0 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-09-01 03:40:27 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Ruediger Landmann 2014-07-25 05:44:05 UTC
Sometimes it would be useful to list product documentation produced with other tools on a Publican-generated splash page for a product. 

* Entries should support the same fields as a Publican-generated book (product/version/title/subtitle/abstract) but should also support the sort_order parameter. 

* Docs linked in such a way should also form part of the DUMP.xml, as part of the suite of documentation that Publican knows about for a particular product.

Comment 1 Jeff Fearn 🐞 2014-07-27 23:00:09 UTC
(In reply to Ruediger Landmann from comment #0)
> * Docs linked in such a way should also form part of the DUMP.xml, as part
> of the suite of documentation that Publican knows about for a particular
> product.

What is the rationale behind this requirement? External systems consuming publican content should communicate with the external system directly. This makes it easy to remove publican from the mix should that be required.

Comment 2 Jeff Fearn 🐞 2014-07-27 23:29:52 UTC
Please provide a few examples for testing.

Comment 3 Summer Long 2014-07-28 01:09:19 UTC
Jeff, we're thinking of the drupal articles. E.g. https://access.redhat.com/articles/1127153

Comment 4 Jeff Fearn 🐞 2014-07-28 01:35:13 UTC
I need multiple links with all the information you want on the page.

Preferably in this format:

<member role="$sort_order" title="$title" href="$uri" version="$version">$sub_title</member>

And I'll need to know which product each link is for, but that isn't part of the XML as each product will have a separate list.

Comment 5 Jeff Fearn 🐞 2014-07-28 01:37:09 UTC
If you don't have real ones in prod then give me fake ones that link to personal pages or something.

Comment 6 Jeff Fearn 🐞 2014-07-28 04:47:58 UTC
To ssh://git.fedorahosted.org/git/publican.git
   f84ff5c..2eefbb4  devel -> devel

To ssh://git.fedorahosted.org/git/publican-redhat.git
   a48506e..623425b  devel -> devel

  <member role="10" title="The Ways And Means Of Pants" href="https://pants.redhat.com" version="6">Pants in all thier glory!</member>

one member per link!

Comment 7 Jeff Fearn 🐞 2014-07-28 04:50:16 UTC
to be clear:

role = sort_order
title = title
href = url
version = product version
member content = sub title

There is no validation done on anything nor are the URLs vetted or limited to any domains.

Comment 8 Summer Long 2014-08-25 03:23:59 UTC
<simplelist> tags to be placed in en-US/External_Links.xml file.

Comment 9 Summer Long 2014-08-25 06:30:31 UTC
Both links and real docs are showing up in their proper place on the splash page. Verified.

Comment 10 Jeff Fearn 🐞 2014-09-01 03:40:27 UTC
A fix for this shipped in Publican 4.2.0.