Change icons and title when build on RTD from a PR#1598
Change icons and title when build on RTD from a PR#1598parulin wants to merge 1 commit intoQubesOS:mainfrom
Conversation
ccc9890 to
ef65dac
Compare
ef65dac to
aa50bec
Compare
79edb1c to
9f57867
Compare
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.
9f57867 to
28b098e
Compare
|
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. |
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? |
|
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? :) |
|
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 |
|
right now I think there are just two subjective approaches to the decoration of the message "This is a PR". |
|
Okay so there are two solutions, and we would like another opinion:
|
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.