Rewrite the front-end of docs.kde.org
Needs ReviewPublic

Authored by ognarb on Jan 2 2019, 11:47 PM.

Details

Summary

Inspired by the new Kontact website and the KDE website. You can preview it on my personal website: http://docs.carlschwan.eu/.

old:

new:

NOTE: The extractor remains the same and the generated URL should also remain the same.

New Features

  • UI is completely translatable
  • Use same design as kontact.kde.org, kde.org, ...
  • Responsive design

Libraries used (all FOSS)

  • Server-side: Symfony (php)
  • Client-side: Bootstrap 4 (sass version) and Symfony encore

TODO

  • Add Unit-test
  • Make sure the xapian based search works
  • ...

Accessibility

  • Search and menu works without ECMAScript
  • Optimize screen reader setup
  • uses aria attributes when needed.
  • Mobile design
  • use semantic html (main, footer, nav HTML elements)
  • Check if all images contains alt
Test Plan

None for the moment, but I will add some unit/integration tests

Diff Detail

Repository
R184 Documentation Website (docs.kde.org)
Branch
master
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 11985
Build 12003: arc lint + arc unit
There are a very large number of changes, so older changes are hidden. Show Older Changes
ognarb edited the summary of this revision. (Show Details)Jan 25 2019, 10:15 PM
ognarb retitled this revision from [WIP] Rewrite the front-end of docs.kde.org to Rewrite the front-end of docs.kde.org.Jan 25 2019, 11:51 PM
ognarb edited the summary of this revision. (Show Details)
ognarb updated this revision to Diff 50307.Jan 25 2019, 11:53 PM

Fix pagination in generated html

Thanks for the effort so far. I will need some time to review it. Especially the translation part, the removal of the old search should not be part of the change.

Please keep in mind that I will change the structure of the files in the repository (the static files which ends up in the generated site, the configuration files are a bit mixed up), so you will need a rebase.

I didn't use symfony, but doesn't it support gettext natively?

Thanks for the effort so far. I will need some time to review it. Especially the translation part, the removal of the old search should not be part of the change.

Thanks, take your time :D. I will try to revert to using the old search, but I will probably create a separate diff with the new search engine or with the old one with the new features (localized search and autocompletion).

Please keep in mind that I will change the structure of the files in the repository (the static files which ends up in the generated site, the configuration files are a bit mixed up), so you will need a rebase.

Ok, no problem.

I didn't use symfony, but doesn't it support gettext natively?

Just found out that symphony translation system, also support po files, even though it isn't specified in the doc.

Hello @ltoscano,

I will probably revert most of the change and just apply the new theme to the old website. This will be probably easier for you to review and I'm not sure anymore that Symfony was a good choice (maybe a bit to big as a framework for that we need to do).

Will probably start to work at it after my exams, so after the 18.

Oh, sure, no rush - and thank you for exploring that option.

ognarb updated this revision to Diff 52608.Feb 26 2019, 1:19 PM

Remove more useless symfony component

ognarb updated this revision to Diff 52612.Feb 26 2019, 1:41 PM

Integrate old search

ognarb updated this revision to Diff 52615.Feb 26 2019, 2:11 PM

Update project structure

ognarb updated this revision to Diff 52686.Feb 26 2019, 9:59 PM

Remove obsolete function

ognarb updated this revision to Diff 53164.EditedMar 4 2019, 8:43 PM
  • Finish reworking directory structure
  • Use old sorting algo for sorting categories
  • Rework the module list

docs.carlschwan.eu also updated (old search still not working, need to fix my apache config)

sheedy added a subscriber: sheedy.Apr 17 2019, 3:23 AM
ognarb updated this revision to Diff 56431.Apr 17 2019, 12:41 PM
  • add a responsive card for the categories list
  • Remove dead code
ognarb updated this revision to Diff 56432.Apr 17 2019, 12:50 PM
  • add a responsive card for the categories list
ognarb updated this revision to Diff 56438.Apr 17 2019, 2:08 PM
  • Use a card layout for the modules list
ognarb updated this revision to Diff 56477.Apr 17 2019, 8:43 PM
  • use https instead of http
ognarb updated this revision to Diff 56479.Apr 17 2019, 9:16 PM

Use same hierarchy as the old version

ognarb updated this revision to Diff 56480.Apr 17 2019, 9:34 PM

Fix responsiveness issues

ognarb updated this revision to Diff 56558.Apr 18 2019, 7:55 PM

Fix regressions found

ognarb edited the summary of this revision. (Show Details)Apr 18 2019, 8:58 PM
ognarb updated this revision to Diff 56560.Apr 18 2019, 9:00 PM

Add cache expiration

ngraham accepted this revision as: VDG.Apr 18 2019, 9:08 PM
ngraham added a subscriber: ngraham.

Looks fantastic visually!

ognarb updated this revision to Diff 56563.Apr 18 2019, 9:28 PM
ognarb added a subscriber: filipf.

Use Noto Sans and if not found generic sans-serif. Thanks @filipf

Looks fantastic visually!

Thanks ;)

Now I only need to work on accessibility (noscript and screen reader users) and the xapian search engine. πŸŽ‰

GB_2 added a comment.Apr 25 2019, 6:58 PM

Just one tip, I'd replace the "Search" button with a search icon, since it looks better and the search placeholder already says "Search...".

GB_2 added a comment.Apr 25 2019, 7:08 PM

And also make it blue like the other search button.

ognarb updated this revision to Diff 57145.EditedApr 28 2019, 7:51 PM
  • Add breeze-icons submodule
  • Use edit-find for the search button and change colour to blue
  • Use proper font size
  • Add .arcconfig
  • Submit form directly after selecting an autocomplete sugestion
ognarb updated this revision to Diff 57146.Apr 28 2019, 8:36 PM
  • Add noscript support (link to /menu when can't open a dropdown)
ognarb updated this revision to Diff 57903.May 11 2019, 12:19 PM

Update directories structure - move static assets to assets
Add icon and konqi-docbook

ognarb edited the summary of this revision. (Show Details)May 11 2019, 12:24 PM
ognarb added a project: Websites.
ognarb updated this revision to Diff 58192.May 17 2019, 2:09 PM

Use rsyncsite for deploying now works

ognarb updated this revision to Diff 58352.May 20 2019, 12:38 PM

Search should now works (not tested because I'm unable to install xapian-search in Arch Linux)

ognarb updated this revision to Diff 58358.May 20 2019, 12:54 PM

Update apache config

ognarb added a comment.Jun 1 2019, 4:18 PM

@ltoscano friendly ping ;)

I didn't forget, which doesn't mean that I could act so far.

I didn't forget, which doesn't mean that I could act so far.

Let me know then you have time, to test it.

ognarb added a subscriber: kde-www.Jun 5 2019, 12:40 PM
ognarb added a subscriber: chempfling.

Hello @chempfling, I saw that you was involved with accessibility around KDE. I would love to get some feedback on the accessibility of this website http://docs.carlschwan.eu.

I already know about the accessibility problem with the language picker (I will change it), but I would love to get more feedback and improvement ideas to make the documentation more accessible.

Hello @chempfling, I saw that you was involved with accessibility around KDE. I would love to get some feedback on the accessibility of this website http://docs.carlschwan.eu.

I already know about the accessibility problem with the language picker (I will change it), but I would love to get more feedback and improvement ideas to make the documentation more accessible.

howdy @ognarb,

i will evaluate it in the next couple of days and give you feedback.
Thanks for take care about that :)!