Opened 2 years ago

Closed 2 years ago

Last modified 2 years ago

#18170 closed bug (fixed)

Userguide: Dark mode haiku logo missing

Reported by: nephele Owned by: nielx
Priority: normal Milestone: R1/beta5
Component: Documentation Version: R1/beta4
Keywords: Cc: humdinger, waddlesplash
Blocked By: Blocking:
Platform: All

Description

In the userguide the dark mode logo is missing completely.
I'm not sure how this happened, the images were added in the same commit as the css changes that use them, now however they are fine in the git repo but simply are not there in the finished userguide packages and the online website version.

For reference the missing files are:
userguide/images/HaikuDark.svg
userguide/images/LeafDark.png
userguide/images/LeafDark.svg

Attachments (1)

screenshot6.png (65.0 KB ) - added by nephele 2 years ago.

Download all attachments as: .zip

Change History (17)

by nephele, 2 years ago

Attachment: screenshot6.png added

comment:1 by nielx, 2 years ago

The userguide gets exported from the userguide tool and the logos are not in there. Which commit are you referencing?

comment:2 by nephele, 2 years ago

The dark mode variant logo was added in this commit: https://cgit.haiku-os.org/userguide/commit/?id=03ceb64ecb3fb66d235b2e106bcc4099c3d9dda8

They were still there with this commit: https://cgit.haiku-os.org/userguide/commit/userguide/images?id=03ceb64ecb3fb66d235b2e106bcc4099c3d9dda8

It seems the newest commit "Synchronize from the Translator." Has also deleted them from the repository for some reason?

https://cgit.haiku-os.org/userguide/commit/userguide/images?id=5ed0f23b8e00e84e0030f77999f89bd1c13f78dc

comment:3 by nielx, 2 years ago

Cc: waddlesplash added

@humdinger/@waddlesplash: my senses tell me to add these missing files to the resources on the userguide tool. I see that several changes have been made directly to the repository. Has the position on how changes are made to the user guide changed?

comment:4 by humdinger, 2 years ago

Sounds about right. Since the userguide was moved out of the Haiku tree to https://github.com/haiku/userguide all changes should be done t the userguide tool, if possible.

comment:5 by nielx, 2 years ago

Status: newin-progress

Will start migrating the files then.

comment:6 by nielx, 2 years ago

Made the following changes in the userguide tool:

  • aa633b2 HaikuDepot: Show Publish Date
  • 03ceb64 HaikuDark.svg, LeafDark.png, LeafDark.svg
  • 41554ed Haiku-doc.css, full export with the latest fixes. This required manual uploading of the Haiku-doc.css file directly into the container, because the userguide translator validates whether the upload is an image.

I have applied the dark mode both to the userguide and to the welcome tour package. I did note that the up arrow in the next to the titles still looks a bit odd, so that may be interesting future work.

In order to close the ticket, I will do a full sync of the user guide later.

comment:7 by nephele, 2 years ago

Thanks!

Yes it does look slightly wierd, it's not perfect but a good improvement.

The css was already there before and worked, not sure what you had to do there :)

in reply to:  7 comment:8 by nielx, 2 years ago

Replying to nephele:

Thanks!

Yes it does look slightly wierd, it's not perfect but a good improvement.

The css was already there before and worked, not sure what you had to do there :)

In worst case I copied over the exact same file :-)

comment:9 by nephele, 2 years ago

On a related note: I have not changed css specific to the userguide tool, does it work alright now? Or is more work required? (and if yes how would I go about testing it)

in reply to:  9 comment:10 by nielx, 2 years ago

Milestone: UnscheduledR1/beta5
Resolution: fixed
Status: in-progressclosed

Replying to nephele:

On a related note: I have not changed css specific to the userguide tool, does it work alright now? Or is more work required? (and if yes how would I go about testing it)

You could synchronize the userguide now, as I have manually updated it in 6ddf008 to be in sync with the tool. That includes the latest CSS changes both for the userguide and welcome.

Let me know if it needs any further changes.

comment:11 by nephele, 2 years ago

I don't actually have an account for the userguide translation tool, hence me not testing wether it works with the dark mode :)

I'd likely need a local way to test this in any case.

in reply to:  11 comment:12 by nielx, 2 years ago

Replying to nephele:

I don't actually have an account for the userguide translation tool, hence me not testing wether it works with the dark mode :)

I'd likely need a local way to test this in any case.

I updated the userguide git repository, you can git clone https://review.haiku-os.org/userguide to get it.

comment:13 by nephele, 2 years ago

That is how I've made the css dark mode in the first place yeah.

But as I understand it the translation tool itself also has css specific to it which might need adjusting.

in reply to:  13 comment:14 by nielx, 2 years ago

Replying to nephele:

That is how I've made the css dark mode in the first place yeah.

But as I understand it the translation tool itself also has css specific to it which might need adjusting.

I am not sure I am following you. The translation tool has its own CSS, for the tool itself. That does not seem to support dark mode. The translation tool also owns all the master resources, including all images, text and CSS for the welcome and userguide pages. I have now made sure that this has all the dark mode changes necessary, so that any future exports from there will have all the resources. The git repository should only contain exports from the userguide tool.

If you want to add dark mode to the userguide tool itself, the source is available on GitHub, though it is a very specific homegrown tool, and I am not sure how easy/difficult it is to spin up a local env so that you can test making changes to the CSS.

comment:15 by nephele, 2 years ago

The git repository should only contain exports from the userguide tool.

Where should I submit future changes? Submitting this over gerrit to the repo got us here anyhow.

.

If you want to add dark mode to the userguide tool itself, the source is available ​on GitHub, though it is a very specific homegrown tool, and I am not sure how easy/difficult it is to spin up a local env so that you can test making changes to the CSS.

Yes that is what I ment, if the edited userguide is in dark mode the tool likely should be too. I guess I'll have to see how easy it is to run locally.

in reply to:  15 comment:16 by nielx, 2 years ago

Replying to nephele:

The git repository should only contain exports from the userguide tool.

Where should I submit future changes? Submitting this over gerrit to the repo got us here anyhow.

I think submitting it here will probably be the best, though it might be worth to get a gerrit bot that adds a reminder when someone submits something there.

Yes that is what I ment, if the edited userguide is in dark mode the tool likely should be too. I guess I'll have to see how easy it is to run locally.

Up to you. Whenever you are in the tool and want to see a preview, that does use the final CSS style sheet so the preview is in dark mode. Up to you if you want to invest in making the document editor/translator tool itself dark.

.

If you want to add dark mode to the userguide tool itself, the source is available ​on GitHub, though it is a very specific homegrown tool, and I am not sure how easy/difficult it is to spin up a local env so that you can test making changes to the CSS.

Yes that is what I ment, if the edited userguide is in dark mode the tool likely should be too. I guess I'll have to see how easy it is to run locally.

You might not have to do a lot.

Note: See TracTickets for help on using tickets.