Skip to content

Change icons and title when build on RTD from a PR#1598

Open
parulin wants to merge 1 commit intoQubesOS:mainfrom
parulin:custom-pr-build
Open

Change icons and title when build on RTD from a PR#1598
parulin wants to merge 1 commit intoQubesOS:mainfrom
parulin:custom-pr-build

Conversation

@parulin
Copy link
Contributor

@parulin parulin commented Dec 24, 2025

By checking some environment variable from Read The Docs in conf.py, we can determine if the build is made from a PR build. In that case, the HTML title is slightly different and instead of normal icons, we use red-tinted ones.

That way, putting some links to the PR builds overview will be clearing distinct from the official build.

@parulin parulin force-pushed the custom-pr-build branch 4 times, most recently from ccc9890 to ef65dac Compare December 24, 2025 20:44
@parulin parulin changed the title Change the RTD post_checkout job to target PRs Change icons and title when build on RTD from a PR Jan 31, 2026
@parulin parulin force-pushed the custom-pr-build branch 2 times, most recently from 79edb1c to 9f57867 Compare February 2, 2026 10:21
By checking some environment variable from Read The Docs in conf.py, we
can determine if the build is made from a PR build. In that case, the
HTML title is slightly different and instead of normal icons, we use
red-tinted ones.

That way, putting some links to the PR builds overview will be clearing
distinct from the official build.
@parulin parulin marked this pull request as ready for review February 3, 2026 13:00
@maiska
Copy link
Contributor

maiska commented Feb 24, 2026

I am not sure that red coloring is the best way to approach this. It adds some uneasy feeling to the person viewing the docs.
I think it suffices that when a build is made from a PR - it is highly visible in the url, you cannot miss it :) and there is the option on the side, to show a diff :)

@parulin
Copy link
Contributor Author

parulin commented Feb 24, 2026

It adds some uneasy feeling to the person viewing the docs.

That was my goal here: if I put a link to a PR in the forums, I want the reader to feel like it's not official.

But if it's unpleasant for the maintainers, I can just touch the opengraph meta data?

@maiska
Copy link
Contributor

maiska commented Feb 24, 2026

My point is not being unpleasant for the maintainers but for the person to read this. Maintainers are in this context not relvant imho. opengraph sounds good? and perhaps not red? it is alarming somehow :) perhaps shade of blue that is mixed with gray as to indicate 'inactive' meaning not merged yet? :)

@parulin
Copy link
Contributor Author

parulin commented Feb 24, 2026

I choose red to mimic the "untrusted" qube. Very few people should be reading the PR builds and being alarmed in this context is better than too confident, don't you think?

I used qvm-get-tinted-image to make the pictures so if you want another color, just tell me the hexadecimal value I need to use :)

@maiska
Copy link
Contributor

maiska commented Feb 24, 2026

right now I think there are just two subjective approaches to the decoration of the message "This is a PR".
and perhaps it's best to let someone else decide :))

@parulin
Copy link
Contributor Author

parulin commented Feb 25, 2026

Okay so there are two solutions, and we would like another opinion:

  1. the current PR
  2. just changing the OpenGraph meta data and using another color to tint the images

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants