SoK/2021/StatusReport/Pablo Marcos: Difference between revisions
Created first status report |
Prettier |
||
| Line 1: | Line 1: | ||
= New Website for Okular = | == New Website for Okular == | ||
== Background == | === Background === | ||
Okular is a multifaceted program that I use almost every day for my PDF reading and annotating needs, although it can do much more. Sadly, its website is a bit outdated and not mobile friendly. I thus proposed to rewrite the Okular website using the HUGO framework, in a similar way as was done with the kde.org main website, keeping consistency with other KDE applications such as https://konsole.kde.org/. Fortunately, some work was already initiated by Carl Schwan, so I only needed to continue and finish his work. | Okular is a multifaceted program that I use almost every day for my PDF reading and annotating needs, although it can do much more. Sadly, its website is a bit outdated and not mobile friendly. I thus proposed to rewrite the Okular website using the HUGO framework, in a similar way as was done with the kde.org main website, keeping consistency with other KDE applications such as https://konsole.kde.org/. Fortunately, some work was already initiated by Carl Schwan, so I only needed to continue and finish his work. | ||
== Mentors == | === Mentors === | ||
* [https://invent.kde.org/carlschwan/ Carl Schwan] | * [https://invent.kde.org/carlschwan/ Carl Schwan] | ||
== Links == | === Links === | ||
Repositories | Repositories | ||
| Line 14: | Line 14: | ||
* [https://invent.kde.org/carlschwan/okular-kde-org/-/tree/work Working Repo] | * [https://invent.kde.org/carlschwan/okular-kde-org/-/tree/work Working Repo] | ||
== Work Done == | === Work Done === | ||
=== February 2021 === | ==== February 2021 ==== | ||
I started by [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/e3e8529ff33be74ea4d9ed59406fdef4e5418127 porting the Anouncements section from Raw HTML to Markdown], for which I wrote a small script. Then, I [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/9229e022294accb9b279d87f3d91fb1693251a61 configured the project] to use the [https://invent.kde.org/websites/aether-sass aether-sass] (kde's HUGO standard theme) as a Go module, as Git submodules were less desirable. Finally, I added [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/62829821d073506f15e46def4d0f1418ec215834 a FAQ section], which was easy since most questions had been removed from the FAQ in a recent cleanup. For this, I used the </details> and </summary> HTML labels, which I didnt know about and which seem super cool to me. | I started by [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/e3e8529ff33be74ea4d9ed59406fdef4e5418127 porting the Anouncements section from Raw HTML to Markdown], for which I wrote a small script. Then, I [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/9229e022294accb9b279d87f3d91fb1693251a61 configured the project] to use the [https://invent.kde.org/websites/aether-sass aether-sass] (kde's HUGO standard theme) as a Go module, as Git submodules were less desirable. Finally, I added [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/62829821d073506f15e46def4d0f1418ec215834 a FAQ section], which was easy since most questions had been removed from the FAQ in a recent cleanup. For this, I used the </details> and </summary> HTML labels, which I didnt know about and which seem super cool to me. | ||
=== March 2021 === | ==== March 2021 ==== | ||
See WIP section | See WIP section | ||
| Line 28: | Line 28: | ||
== What I've learnt so far == | === What I've learnt so far === | ||
* The HTML labels </details> and </summary> exist! This has been super useful, as I have already used that knowledge in some personal projects :p | * The HTML labels </details> and </summary> exist! This has been super useful, as I have already used that knowledge in some personal projects :p | ||
* How to use HUGO in general | * How to use HUGO in general | ||
== Contact == | === Contact === | ||
If you want to make suggestions in this project do contact me. | If you want to make suggestions in this project do contact me. | ||
Revision as of 09:52, 8 March 2021
New Website for Okular
Background
Okular is a multifaceted program that I use almost every day for my PDF reading and annotating needs, although it can do much more. Sadly, its website is a bit outdated and not mobile friendly. I thus proposed to rewrite the Okular website using the HUGO framework, in a similar way as was done with the kde.org main website, keeping consistency with other KDE applications such as https://konsole.kde.org/. Fortunately, some work was already initiated by Carl Schwan, so I only needed to continue and finish his work.
Mentors
Links
Repositories
Work Done
February 2021
I started by porting the Anouncements section from Raw HTML to Markdown, for which I wrote a small script. Then, I configured the project to use the aether-sass (kde's HUGO standard theme) as a Go module, as Git submodules were less desirable. Finally, I added a FAQ section, which was easy since most questions had been removed from the FAQ in a recent cleanup. For this, I used the </details> and </summary> HTML labels, which I didnt know about and which seem super cool to me.
March 2021
See WIP section
Work in Progress
I am currently working on the /download and /build-it pages. I wrote a HTML mockup, and am in the process of transitioning to a HUGO markdown and HTML templae format.
What I've learnt so far
- The HTML labels </details> and </summary> exist! This has been super useful, as I have already used that knowledge in some personal projects :p
- How to use HUGO in general
Contact
If you want to make suggestions in this project do contact me.
Matrix :- @pablitouh:matrix.org