Martyn Welch authored 4 years ago and Emanuele Aina committed 4 years ago

The website is using a mix of serif and sans-serif fonts, switch to using
sans-serif throughout site to make it more uniform.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Currently if a sitebar item is a sub-section rather than a page, focus and
highlighting is not applied to the section heading. This is because the
current section is not the first level section, it's the sub-section.

Tweak the logic to compare first level sections.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Emanuele Aina committed 4 years ago

The site bar currently highlights all sections in orange. A request has
been made to uniquely highlight a section of the current document.

Switch the highlighting of the menu entries to blue by standard (a lighten
version of the Apertis blue as the standard blue is too dark) and use
orange for the selected section if needed.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Emanuele Aina committed 4 years ago

We mostly use a serif font for text bosy, however the search is currently
using sans serif. The search results are also very spaced out, limiting
the number that are visible on the screen at any one time.

Tweak to use the serif font used elsewhere and loose some of the white
space.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

The current notice box implementation expects a simple paragraph content.
Tweak the CSS to allow much more complex and/or non paragraph content.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Peter Senna Tschudin committed 4 years ago

The pages in the site map are currently ordered by date. This doesn't make
much sense in the list. Order alphabetically instead to make it a bit
clearer.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Emanuele Aina committed 4 years ago

We have enabled the generation of PDFs when appropriate using a custom
output type "pdf-in". When the PDF is being produced, add a link to the
page to alert readers to its existance.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Martyn Welch committed 4 years ago

The site menu is quite long. When we are in a section, scroll the menu to
the relevant section.

This is a bit hacky due to the navbar at the top and the way the theme is
constructed. In order to avoid issues with the scrolling distance being
incorrectly calculated (due to reflow of text as the side bar gets wider)
animate as a drop-down instead of appearing from the side.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Martyn Welch committed 4 years ago

We can change the logic subtly and reduce replication of properties.
Also set visibility to improve accessibility.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

It has been communicated to us that the menu on the left hand side of the
designs.apertis.org site is missed when looking for documents on the
website. Implement a basic site menu in a sidebar to get feedback.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

We are currently adding anchor links to all headings. This includes the
page titles, which is the one heading to which we really don't need a
link. The page title is also centered and the addition of the anchor
causes the normally visible part of the title to be nudged to rendered off
center. This is visually unappealing, so stop adding anchors to the page
titles.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

After trying to manually create a link to a page section for the nth time,
I finally scratched that itch and added AnchorJS to provide the links for
us. This greatly simplifies the process for linking to sections of pages,
especially useful for those not versed in digging around in the page
source.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Emanuele Aina committed 4 years ago

Hugo automatically generates IDs for each title when the HTML pages are
generated. These IDs can be used as anchors in the document, so that we
can provide URLs that jump to the specific title when the link is
followed. Browsers will place the anchor at the top of the window,
however we have a floating navigation bar there which results in the
anchor being obscured, which can be a bit disorientating.

Tweak the CSS to pad the top of the heading, but in a way that doesn't
result in the heading being visibily spaced further from the previous
text. Add override to main page heading to stop it being padded down
the page.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Apertis currently has a large number of concept documents on
designs.apertis.org. To improve branding, searchability and reduce
maintenance, it would be better to have all these documents under the
main website. One feature that the website is currently missing that is
provided on designs.a.o is PDF generation, which is used when reviewing
concepts with Bosch.

Carry over the PDF generation functionality from designs.a.o and
implement a mechanism for generating PDFs from the Hugo site on
www.apertis.org so that we can move documents over from designs.a.o
without loosing needed functionality.

To do this we will generate simplfied HTML documents, with the
extension `.pdf-in` when documents require this to be generated in
their frontmatter, for example to generate html and the simplified HTML
add:

    outputs = ["html", "pdf-in"]

The create-pdf script will be run for each of these via the CI pipeline
which will use a lightly modified version of the tooling used for
designs.a.o to create the PDF and place it back into the site.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Add Hugo shortcodes and CSS to Hugo theme to allow notice blocks to be
added to the markdown. There are 4 types available:

- warning
- info
- note
- tip

By adding the following hugo shortcode around some text a formatted box is
added to the HTML output:

    {{% notice info %}}
    Text for notice
    {{% /notice %}}

This will be useful for highlighting important information.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Emanuele Aina committed 4 years ago

In order to ensure a consistent look to the site, always use the same css
for page headings, don't require each section to define it's own css.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

The current search indexing only looks at "regular pages". This ensures
that a lot of the content is indexed and avoids the indexing of taxonomies
and other broadly irrelevant types of content in the index. However, it
does result in certain lists pages not being included in the index that
may contain valuable information.

The value of having the list pages indexed currently outweights the impact
of potentially including other tertiary data in the index, for a start
we're not currently using taxonomies. This should be re-evaluated as and
when we're able to spend time better structuring the website.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

For users on slower connections/computers, the search index can take a
while to download and for the search to complete.

- Add a "Loading..." message to provide the user with some early feedback.
- Bump up the size of the text used when displaying status messages to
  make then clearer.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

The current search is using the URL "<site>/search", which is getting
redirected to the true location "<site>/search/". When running through
Hugo, the server it runs on localhost is maintaining the GET request
across the redirect, the hosting isn't.

The easiest (and arguably best) way or dealing with this is to correct the
URL so that no redirect is needed.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Martyn Welch authored 4 years ago and Emanuele Aina committed 4 years ago

The statically generated site currently does not currently offer search
functionality. Whilst we could rely to a degree on search engines to index
the Apertis website (for example by using the provided integration of
Google Custom Search Engine) but it is expected that the website will be
used as the basis for more taylored sites by users of Apertis that may be
implemented out of the reach of the search engines indexing and thus
localised search is required.

Remove the Google search integration in the theme and instead integrate
local search based on the approach documented here:

https://gist.github.com/eddiewebb/735feb48f50f0ddd65ae5606a1cb41ae#layouts_defaultsearchhtml



Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

The theme doesn't provide a mechanism to have links in the footer. Add one
and include the links to important information that we had on the wiki.

As the code of conduct is now in the footer. Add a download link in the
header.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

There are a number of rules setup to redirect to qa.images.org for test
cases. We can do this with a custom layout and slightly abusing the "title"
variable in the front matter to give us the name of the test.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

The theme seems to have a number of images in the static folder that
aren't used. To ensure that these don't get served by the Apertis site
remove them.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

The stock 404 page contains a southpark meme. As this may not be to
everyones taste remove it (and simplify the message used a little).

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

We are now using the Beautiful Hugo theme, remove the Simple Hugo Theme as
it's no longer required.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

The Simple Hugo theme is a bit too minimalistic (which was helpful during
conversion from a wiki, but less desirable as we look to go public with
the hugo site. Switch back to the Beautiful Hugo theme and tweak both the
theme and the config to get the site a little closer to Apertis branding.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

We re not using the Lanyon theme, so remove it from the repo.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>

Add latest scripted conversion of wiki pages and move to simple
Hugo theme.

Signed-off-by: Martyn Welch <martyn.welch@collabora.com>