Bug 617724 – devmanual is not suitable for offline browsing

• Product: Documentation
• Status: RESOLVED FIXED

[Description Andriy Utkin (RETIRED) 2017-05-07 12:05:03 UTC]

devmanual, as installed by portage, uses assets located on the Internet:

$ ag assets.gentoo.org
devbook.xsl
436:      <link href="https://assets.gentoo.org/tyrian/bootstrap.min.css" rel="stylesheet" media="screen" />
437:      <link href="https://assets.gentoo.org/tyrian/tyrian.min.css" rel="stylesheet" media="screen" />
470:                  <object data="https://assets.gentoo.org/tyrian/site-logo.svg" type="image/svg+xml">
471:                    <img src="https://assets.gentoo.org/tyrian/site-logo.png" alt="Gentoo Linux Logo" />
560:      <script src="https://assets.gentoo.org/tyrian/jquery.min.js"></script>
561:      <script src="https://assets.gentoo.org/tyrian/bootstrap.min.js"></script>

It seems offline browsing is an important usecase for locally installable doc
package.


Reproducible: Always

Steps to Reproduce:
1. emerge devmanual
2. turn off the internet connection
3. open local devmanual (file:///usr/share/doc/devmanual/html/index.html) in a browser session with empty cache
Actual Results:  
When browsing offline, the text is white, the background is grey and links are
blue, which is unpleasant to the degree of causing some eyestrain.

Expected Results:  
Nice look just as at http://devmanual.gentoo.org

[Comment 1 Ulrich Müller 2017-05-12 10:45:24 UTC]

Unless we want to drop Tyrian layout from the Devmanual altogether, I see the following alternatives:
- Bundle all needed files with the devmanual package, and change all URLs pointing to assets.gentoo.org to relative ones. It's some 30 files with about 2 MB total size (mostly due to fonts).
- Create a package like {app-doc,media-gfx,www-misc}/tyrian-gentoo that installs a snapshot of https://github.com/gentoo/tyrian/ and have the devmanual depend on it.

CCing WWW team, would the latter be an option?

[Comment 2 Rage <oxr463> 2019-01-03 02:37:48 UTC]

(In reply to Ulrich Müller from comment #1)
> Unless we want to drop Tyrian layout from the Devmanual altogether, I see
> the following alternatives:
> - Bundle all needed files with the devmanual package, and change all URLs
> pointing to assets.gentoo.org to relative ones. It's some 30 files with
> about 2 MB total size (mostly due to fonts).
> - Create a package like {app-doc,media-gfx,www-misc}/tyrian-gentoo that
> installs a snapshot of https://github.com/gentoo/tyrian/ and have the
> devmanual depend on it.
> 
> CCing WWW team, would the latter be an option?

It makes more sense to just bundle the dependencies in my opinion.

I'll work on a proof of concept.

https://gitlab.com/oxr463/gentoo/issues/19

[Comment 3 Larry the Git Cow 2019-06-23 18:10:58 UTC]

The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=e88a07653f941c6326cce8d45fccb654eaeab1d1

commit e88a07653f941c6326cce8d45fccb654eaeab1d1
Author:     Lucas Ramage <[e-mail]>
AuthorDate: 2019-01-05 23:34:05 +0000
Commit:     Ulrich Müller <[e-mail]>
CommitDate: 2019-06-23 18:10:00 +0000

    app-doc/devmanual: Fix assets for offline browsing
    
    Closes: https://bugs.gentoo.org/617724
    Closes: https://github.com/gentoo/gentoo/pull/10974
    Signed-off-by: Lucas Ramage <[e-mail]>
    [sed tweaks converted to patch]
    Package-Manager: Portage-2.3.67, Repoman-2.3.15
    Signed-off-by: Ulrich Müller <[e-mail]>

 app-doc/devmanual/devmanual-9999.ebuild          | 13 +++--
 app-doc/devmanual/files/devmanual-fallback.patch | 60 ++++++++++++++++++++++++
 app-doc/devmanual/metadata.xml                   |  3 ++
 3 files changed, 72 insertions(+), 4 deletions(-)