diff mbox series

[bug#69783] doc: build: Update paths to style sheets.

Message ID 20240315193422.14350-1-sirgazil@zoho.com
State New
Headers show
Series [bug#69783] doc: build: Update paths to style sheets. | expand

Commit Message

vasilii.smirnov--- via Guix-patches" via March 15, 2024, 7:34 p.m. UTC
From: Luis Felipe <sirgazil@zoho.com>

The Guix website style sheets are now organized in themes. This change
makes the documentation builder use the resources provided by a theme
called "initial" (See https://issues.guix.gnu.org/69783).

* doc/build.scm (syntax-highlighted-html): Update path to CSS.
(html-manual-indexes): Likewise.
(stylized-html): Likewise, and update path to language picker image.

Change-Id: Ib2d51fcfdec42ad827add1ead1cfee4c9c4e65b7
---
 doc/build.scm | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)


base-commit: 93aefca7bab5f5b40164176e3224221d26d708f1

Comments

Giovanni Biscuolo March 16, 2024, 9:34 a.m. UTC | #1
Hello,

sirgazil--- via Guix-patches via <guix-patches@gnu.org> writes:

> From: Luis Felipe <sirgazil@zoho.com>
>
> The Guix website style sheets are now organized in themes. This change
> makes the documentation builder use the resources provided by a theme
> called "initial" (See https://issues.guix.gnu.org/69783).
>
> * doc/build.scm (syntax-highlighted-html): Update path to CSS.
> (html-manual-indexes): Likewise.
> (stylized-html): Likewise, and update path to language picker image.
>
> Change-Id: Ib2d51fcfdec42ad827add1ead1cfee4c9c4e65b7

I was looking at this patch set and found that this has been commited as
999bfa0d543c539e4554797deaf2f447dddf3796 (Fri Mar 15 23:22:45 2024)

I'm closing this bug, if I'm doing something wrong please reopen it! :-)

Thanks! Gio'
pelzflorian (Florian Pelz) March 16, 2024, 11:09 a.m. UTC | #2
Reopen.
I had not closed yet because I still had a request to the maintainers:

https://lists.gnu.org/archive/html/guix-patches/2024-03/msg01035.html

Regards,
Florian
Luis Felipe March 16, 2024, 1:52 p.m. UTC | #3
I see that the changes are live now, thanks.

However, the HTML manual for version 1.4.0 still uses the old paths, so 
the style is currently broken (not horribly broken but still).

I'm not sure if the pending actions that require maintainer intervention 
would fix this, so I'm investigating in the meantime.

(I hope I can help make the Texinfo's HTML versions of the manual easier 
to theme soon)
pelzflorian (Florian Pelz) March 16, 2024, 5:47 p.m. UTC | #4
Hrmm.  I see breakage only of the /manual hub page listing the
languages, otherwise I had checked some 14 hours ago and the manual and
site itself worked.  I see some nginx proxy pass directives that last
two days, but I think it is something different.

Luis Felipe <sirgazil@zoho.com> writes:
> (I hope I can help make the Texinfo's HTML versions of the manual
> easier to theme soon)

guix.git’s doc/build.scm says:

;; FIXME: Avoid duplicating styling info from guix-artwork.git.

That would mean downloading guix-artwork.git from within the build
script, like with a fixed-output derivation, but I do not know how to do
downloads from outside package origins beautifully and not as
confusing/unexpected as the test code for the recent fixed-output
derivation vulnerability on the Guix.gnu.org blog.

Regards,
Florian
Giovanni Biscuolo March 17, 2024, 10:51 a.m. UTC | #5
Hello Florian,

"pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de> writes:

> Reopen.
> I had not closed yet because I still had a request to the maintainers:
>
> https://lists.gnu.org/archive/html/guix-patches/2024-03/msg01035.html

Uh sorry! I missed it.

But then, why not wait for the missing information and related patch and
commit all the patches in this bug as a coherent patchset "in bulk"?  If
needed "we" could use a dedicated "doc" branch to test this, no?

I understand that this patch series is "just" for doc presentation
(style) and the missing patch(es) do not "hard" break the manual, but
this workflow makes harder for casual contributors like me to help in
"bug gardening".

WDYT?

Sorry again for the confusion.

Happy hacking! Gio'
pelzflorian (Florian Pelz) March 17, 2024, 4:52 p.m. UTC | #6
Hello Giovanni and thank you for spending time on bug management.

What I wanted from the maintainers is not the reason why
https://guix.gnu.org/manual/ still has the wrong CSS paths.

I had pushed to guix-artwork.git and guix.git without waiting for
maintainers with push authorization to maintenance.git, because I wanted
to fix tabification myself and cause less bother.  Sorry to you that I
did cause inconvenience to you.

I wanted from the maintainers specifically that maintenance.git’s
hydra/nginx/berlin.scm treats /themes the same way as /static.

I believe this would change server-side cache times to be the same for
/themes and for /static.  Regardless of whether they are the same,
server-side cacheing causes the current disruption of the CSS of the
/manual hub page.  I was not sure this would happen, but accept it and
hope the cache issue is gone by itself by tomorrow.

Regards,
Florian
pelzflorian (Florian Pelz) March 17, 2024, 5:57 p.m. UTC | #7
Indeed you are right, Giovanni, that the true problem is that
maintenance.git needs rewrite rules for the CSS and image files.  This
is because the 1.4.0 manual still uses the doc/build.scm of 1.4.0.

My apologies.  I can prepare a patch later.

Regards,
Florian
diff mbox series

Patch

diff --git a/doc/build.scm b/doc/build.scm
index 2cd57b4a92..9ab2ca32d2 100644
--- a/doc/build.scm
+++ b/doc/build.scm
@@ -365,7 +365,7 @@  (define* (syntax-highlighted-html input
                                                             #:languages
                                                             languages))
                                   (syntax-css-url
-                                   "/static/base/css/code.css"))
+                                   "/themes/initial/css/code.css"))
   "Return a derivation called NAME that processes all the HTML files in INPUT
 to (1) add them a link to SYNTAX-CSS-URL, and (2) highlight the syntax of all
 its <pre class=\"lisp\"> blocks (as produced by 'makeinfo --html')."
@@ -624,7 +624,7 @@  (define* (stylized-html source input
                         #:key
                         (languages %languages)
                         (manual %manual)
-                        (manual-css-url "/static/base/css/manual.css"))
+                        (manual-css-url "/themes/initial/css/manual.css"))
   "Process all the HTML files in INPUT; add them MANUAL-CSS-URL as a <style>
 link, and add a menu to choose among LANGUAGES.  Use the Guix PO files found
 in SOURCE."
@@ -741,7 +741,7 @@  (define split-node?
                             (list (menu-dropdown
                                    #:label
                                    `(img (@ (alt "Language")
-                                            (src "/static/base/img/language-picker.svg")))
+                                            (src "/themes/initial/img/language-picker.svg")))
                                    #:items
                                    (language-menu-items file)))
                             #:split-node? split-node?)
@@ -1141,16 +1141,16 @@  (define (sxml-index language title body)
                     ;; Menu prefetch.
                     (link (@ (rel "prefetch") (href ,(guix-url "menu/index.html"))))
                     ;; Base CSS.
-                    (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/elements.css"))))
-                    (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/common.css"))))
-                    (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/messages.css"))))
-                    (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/navbar.css"))))
-                    (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/breadcrumbs.css"))))
-                    (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/buttons.css"))))
-                    (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/footer.css"))))
-
-                    (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/page.css"))))
-                    (link (@ (rel "stylesheet") (href ,(guix-url "static/base/css/post.css")))))
+                    (link (@ (rel "stylesheet") (href ,(guix-url "themes/initial/css/elements.css"))))
+                    (link (@ (rel "stylesheet") (href ,(guix-url "themes/initial/css/common.css"))))
+                    (link (@ (rel "stylesheet") (href ,(guix-url "themes/initial/css/messages.css"))))
+                    (link (@ (rel "stylesheet") (href ,(guix-url "themes/initial/css/navbar.css"))))
+                    (link (@ (rel "stylesheet") (href ,(guix-url "themes/initial/css/breadcrumbs.css"))))
+                    (link (@ (rel "stylesheet") (href ,(guix-url "themes/initial/css/buttons.css"))))
+                    (link (@ (rel "stylesheet") (href ,(guix-url "themes/initial/css/footer.css"))))
+
+                    (link (@ (rel "stylesheet") (href ,(guix-url "themes/initial/css/page.css"))))
+                    (link (@ (rel "stylesheet") (href ,(guix-url "themes/initial/css/post.css")))))
                    (body
                     (header (@ (class "navbar"))
                             (h1 (a (@ (class "branding")