[DOCS-18] Single page version of manuals (in addition to current site, not instead of it) Created: 14/Apr/16  Updated: 11/Aug/20  Resolved: 11/Aug/20

Status: Closed
Project: docs
Component/s: Toolchain
Affects Version/s: Beryllium
Fix Version/s: None

Type: Bug
Reporter: Michael Vorburger Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Operating System: All
Platform: All


External issue ID: 5728

 Description   

Somehow clicking through Next> Next> Next> Next> on docs/manuals/getting-started-guide/target/docbkx/webhelp/bk-getting-started-guide/content/index.html (BTW see DOCS-16 about getting this live published) makes reading that more painful than just scrolling through long single pages such as e.g. https://www.opendaylight.org/installing-opendaylight or https://docs.google.com/document/d/12O86Nc4IbHvBC_ZGE_tHl0IWYd75Lk2HzfcV4YxhWTg/pub - those longs document are kind of a handy format, too.

As Asciidoctor certainly can produce such single page HTML as well, how about also offering that, in addition to the current chunked chapter one? I noticed the PDF icon in the bar on top - perhaps next to it would be a suitable place for a link to a single page HTML of the entire manual? (The PDF itself is less idea to read on-screen I feel, and IMHO not a valid alternative to the additional HTML free flowing format proposed here.)

Would any help to implement this be welcome?



 Comments   
Comment by Colin Dixon [ 17/Jun/16 ]

I think we're trying to move toward this:
https://opendaylight.readthedocs.io/en/latest/

Comment by Colin Dixon [ 08/Jul/16 ]

It would be good if we could generate a single-page HTML version of every guide as part of the publishing to read the docs/sphinx. I think it's possible.

Comment by Thanh Ha (zxiiro) [ 11/Aug/20 ]

The page mentioned in this JIRA no longer exists and we've since moved to ReadTheDocs. Feel free to reopen against ReadTheDocs documentation if anyone still wishes to have this feature.

Generated at Wed Feb 07 19:58:26 UTC 2024 using Jira 8.20.10#820010-sha1:ace47f9899e9ee25d7157d59aa17ab06aee30d3d.