[Bug 261064] /docs/ minor update; orientation; put the new documentation site, and its content, in context

From: <bugzilla-noreply_at_freebsd.org>
Date: Sun, 09 Jan 2022 16:05:16 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261064

            Bug ID: 261064
           Summary: /docs/ minor update; orientation; put the new
                    documentation site, and its content, in context
           Product: Documentation
           Version: Latest
          Hardware: Any
               URL: https://www.freebsd.org/docs/
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Website
          Assignee: doc@FreeBSD.org
          Reporter: grahamperrin@gmail.com

At <https://www.freebsd.org/docs/> the most prominent link to 'documentation'
(in the sole single-sentence paragraph) refers to traditional: 

<https://www.freebsd.org/docs/books/>

– ignoring (for a moment) the 'books' part of the URL, this is fine; there's a
variety of documentation from multiple domains. 

We do have the two references to <https://docs.freebsd.org/en/>: 

* 'Documentation' in the navigation bar

* 'Documentation' at the head of the sidebar

– however the page itself <https://www.freebsd.org/docs/> does not make clear
that the word documentation currently has two very different meanings
(different destinations). 


Maybe re-word the existing paragraph. Something like: 


> Our main <documentation site> comprises material that's managed by 
> the FreeBSD Documentation Project. Contributions from the 
> community are encouraged. 
> 
> Sidebar links, to the left, include: 
> 
> * the FreeBSD Handbook and other popular Documentation Project items
> 
> * items from other areas, including the FreeBSD Foundation.


NB: 

* no use of the word 'portal'

* no more than one link in the body text.


Then add a sidebar link 'Overview' (beneath 'Documentation') with reference to
<https://www.freebsd.org/docs/books/>.

-- 
You are receiving this mail because:
You are the assignee for the bug.