Bug 267636

Summary: The colon in the file name of the security report of the FreeBSD doc is not compatible with Microsoft Windows
Product: Documentation Reporter: ykla <yklaxds>
Component: WebsiteAssignee: freebsd-doc (Nobody) <doc>
Status: Open ---    
Severity: Affects Some People CC: grahamperrin, security-officer
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
Output from sysutils/bfs none

Description ykla 2022-11-08 12:51:14 UTC 
As Hnadbook, The name of the security advisory always begins with FreeBSD-SA- (for FreeBSD Security Advisory), for FreeBSD-SA-14:04.bind, followed by the year in two digit format (14:), followed by the advisory number for that year (04.), followed by the name of the affected application or subsystem (bind). The advisory shown here is the fourth advisory for 2014 and it affects BIND.

https://github.com/Chinese-FreeBSD-Community/freebsd-doc/tree/main/website/static/security/patches

The colon in the above path folder and file names is an illegal file name in Microsoft windows. Microsoft Windows does not allow the colon to appear as part of a folder or file name. Therefore svn or git operations will fail. Only UNIX-like or MacOS operating systems allow this. This severely hinders users from editing FreeBSD documents on the Microsoft Windows platform. To be able to edit this documentation you must first have a class UNIX, and it is well known that the editing experience on these platforms is just not very good, some of them cannot even be configured for input methods.

And the colon doesn't seem necessary, it's not that intuitive, and if I didn't read the Handbook I'd have thought it was the time of publication (hours or minutes). It's perfectly possible to consider using another character instead such as an underscore.
Comment 1 Philip Paeps freebsd_committer freebsd_triage 2022-11-15 03:00:29 UTC 
Cc:ing security-officer@ on this.

I agree that the colon in the filenames of our advisories and errata notices doesn't add much value.  If it's something we can change without much impact, it would make the life of translators a little easier.

Can we change the : to a - in the copy of the SA/EN we upload to the doc repo?

Alternatively (or concurrently) we could look into whether it's possible to add magic to the infrastructure to support both filenames and translators can choose the one that works best in their context.
Comment 2 Graham Perrin freebsd_committer freebsd_triage 2022-11-15 06:16:41 UTC 
Created attachment 238084 [details]
Output from sysutils/bfs

(In reply to Philip Paeps from comment #1)

> … advisories and errata notices …

Checking for colons in paths elsewhere (I see nowhere else): 

find -s /usr/doc -name "*:*" -print

 * output not reproduced here

bfs -s /usr/doc -name "*:*" -print

 * output attached

find -s /usr/ports -name "*:*" -print
find -s /usr/src -name "*:*" -print

 * nothing found.