Skip to content

Updated UI for Sphinx/rtd#118

Open
meengit wants to merge 8 commits intobugzilla:5.2from
meengit:docs-theme-update
Open

Updated UI for Sphinx/rtd#118
meengit wants to merge 8 commits intobugzilla:5.2from
meengit:docs-theme-update

Conversation

@meengit
Copy link
Copy Markdown

@meengit meengit commented Sep 6, 2022 •
edited
Loading

Changes

  • Migrate to a custom Bugzilla theme to support an individual layout of the quick search box and use global color variables (4717eb6)
  • Migrated custom styles with no relation to config.py into the new theme and added a new logo and quick search box
    Updated to Sphinx 5.X as a minimal version (c1227c5, d9f234a)
  • Added several tiny visual improvements, and the copyright notice to the footer

Further notices

  • The new theme inherits from Sphinx's Classic theme. The CSS styles are currently written to not break with old browsers.
  • If needed, I can add or migrate the documentation to Markdown since we can use MyST in Sphinx's context.

Questions

  • Strategy for readthedocs versioning: branch or tag based?
  • How important is the dark mode? I suggest adding one to the next major release. Background: I will update the entire Sphinx theme to support modern CSS with minimal backward compatibility for old browsers.
  • Contents: AFAIK, many contents are outdated. I can start to update and push them in separate PRs. Perhaps I can create GitHub Actions (or similar DevOps/Tests) for each supported version and OS and then cat out code's inline comments to Sphinx docs; with this solution, I guess we can do install-recipes and documentation in one step.

hellcp
hellcp reviewed Sep 6, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@hellcp hellcp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also worry about the performance of the theme on mobile devices, would it be possible to hide the sidebar on lower [at]media widths while still leaving either a link to the search page or the searchbar visible somewhere?

docs/en/themes/bugzilla/static/bugzilla.css_t Outdated
}

div.document {
min-height: 95vh;
Copy link
Copy Markdown
Member

@hellcp hellcp Sep 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an ugly hack, please make the page use flex grow or something that always pushes the footer to the bottom, without doing this, or do not do this at all

Copy link
Copy Markdown
Author

@meengit meengit Sep 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, will remove it!

docs/en/themes/bugzilla/static/bugzilla.css_t Outdated
}

@font-face {
font-family: 'FiraMono Bold';
Copy link
Copy Markdown
Member

@hellcp hellcp Sep 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In Harmony we use Noto Mono

Copy link
Copy Markdown
Author

@meengit meengit Sep 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, will switch to.

@hellcp
Copy link
Copy Markdown
Member

hellcp commented Sep 6, 2022

It would be nice to also add opengraph metadata as a goal sometime in the future, and you should probably rebase on the 5.2 branch because you changed stuff that was removed in the docs as well ;)

@meengit
Copy link
Copy Markdown
Author

meengit commented Sep 6, 2022

@hellcp, thank you for your fast and precise feedback.

I propose:

In this PR I fix the things you mentioned.

Then in a next PR:

I also worry about the performance of the theme on mobile devices, would it be possible to hide the sidebar on lower [at]media widths while still leaving either a link to the search page or the searchbar visible somewhere?

Of course; let me add.

It would be nice to also add opengraph metadata as a goal sometime in the future

Yes, I add support.

@meengit
Copy link
Copy Markdown
Author

meengit commented Sep 7, 2022 •
edited
Loading

Hi @hellcp

  • Resolve merge conflict
  • Replace FiraMono with Noto Mono (e97e8a1)
  • Fix vertical viewport hack (d26e509)

Notes

  • As far as I can see, Noto Mono is now NotoSansMono
  • If no further adjustments are required, I will start to refactor the theme in a new PR (draft) and move away from the current default layout to an independent one (incl. removed inheritance of Sphinx's Classic theme)

@justdave justdave requested a review from hellcp January 27, 2023 12:02
@justdave
Copy link
Copy Markdown
Member

justdave commented Jan 27, 2023

Is there a Bugzilla bug to go with this PR?

@meengit
Copy link
Copy Markdown
Author

meengit commented Jan 27, 2023

Hi @justdave, this PR is the result of a discussion in the matrix chat. I'm also working on a follow-up, especially for mobile devices, as mentioned above in #118 (comment). I try to finish it until the end of February.

justdave added a commit to justdave/bugzilla that referenced this pull request May 6, 2024
@justdave
Bug 1888068: out-of-the-box Docker to demo Bugzilla (bugzilla#118)
690d0e4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hellcp hellcp Awaiting requested review from hellcp

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@meengit @hellcp @justdave