Bug 259371 - Improve documentation: titles should visible in the HTML <title> and in the banner/header
Summary: Improve documentation: titles should visible in the HTML <title> and in the b...
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Website (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Sergio Carlavilla Delgado
URL: https://docs.freebsd.org/en/
Keywords: needs-patch
Depends on:
Blocks: 260576 260705
  Show dependency treegraph
 
Reported: 2021-10-22 23:25 UTC by Graham Perrin
Modified: 2021-12-27 06:37 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Graham Perrin freebsd_committer freebsd_triage 2021-10-22 23:25:50 UTC
<https://docs.freebsd.org/en/> for example: 

> The FreeBSD Project

– should be 

> Documentation – FreeBSD

– (with an en dash) or: 

> Documentation | FreeBSD
Comment 1 Graham Perrin freebsd_committer freebsd_triage 2021-10-22 23:29:33 UTC
… <https://docs.freebsd.org/de/> should be 

> Dokumentation – FreeBSD

… and so on.
Comment 2 Kubilay Kocak freebsd_committer freebsd_triage 2021-10-22 23:38:49 UTC
Suggest including documentation title/name in <title> as well:

  "FreeBSD - Documentation - <Documentation Title/Name>"
Comment 3 Graham Perrin freebsd_committer freebsd_triage 2021-10-23 07:54:18 UTC
(In reply to Kubilay Kocak from comment #2)

Better to have specific first, generic last. 

For specifics to be more immediately visible in tabs, bookmarks and so on. 

Thanks
Comment 4 Graham Perrin freebsd_committer freebsd_triage 2021-12-20 20:07:48 UTC
Given bug 260576, I suspect that (in addition to the HTML title), the new design will require the title of the document to be visible in the red banner/header at the top of the page.
Comment 5 commit-hook freebsd_committer freebsd_triage 2021-12-26 21:43:33 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=e099a72b5edd7c1f4e9e3ded84403105955025f2

commit e099a72b5edd7c1f4e9e3ded84403105955025f2
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2021-12-26 21:41:10 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2021-12-26 21:41:10 +0000

    Upgrade FreeBSD Documentation Portal title to Documentation Portal

    PR:             259371
    Submitted by:   Graham Perrin <grahamperrin (AT) gmail.com>

 documentation/config/_default/languages.bn-bd.toml | 2 +-
 documentation/config/_default/languages.da.toml    | 2 +-
 documentation/config/_default/languages.de.toml    | 2 +-
 documentation/config/_default/languages.el.toml    | 2 +-
 documentation/config/_default/languages.en.toml    | 2 +-
 documentation/config/_default/languages.es.toml    | 2 +-
 documentation/config/_default/languages.fr.toml    | 2 +-
 documentation/config/_default/languages.hu.toml    | 2 +-
 documentation/config/_default/languages.it.toml    | 2 +-
 documentation/config/_default/languages.ja.toml    | 2 +-
 documentation/config/_default/languages.ko.toml    | 2 +-
 documentation/config/_default/languages.mn.toml    | 2 +-
 documentation/config/_default/languages.nl.toml    | 2 +-
 documentation/config/_default/languages.pl.toml    | 2 +-
 documentation/config/_default/languages.pt-br.toml | 2 +-
 documentation/config/_default/languages.ru.toml    | 2 +-
 documentation/config/_default/languages.tr.toml    | 2 +-
 documentation/config/_default/languages.zh-cn.toml | 2 +-
 documentation/config/_default/languages.zh-tw.toml | 2 +-
 19 files changed, 19 insertions(+), 19 deletions(-)
Comment 6 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2021-12-26 21:46:50 UTC
I updated the Documentation Portal title.
Thanks for this, I forgot about this change :)
Comment 7 Graham Perrin freebsd_committer freebsd_triage 2021-12-27 06:37:41 UTC
Thanks, should I raise separate bugs for pages such as 
<https://docs.freebsd.org/en/>?