Bug 213526 - [patch] refactor Security page on website
Summary: [patch] refactor Security page on website
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Website (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Many People
Assignee: Security Team
URL:
Keywords: patch
Depends on:
Blocks:
 
Reported: 2016-10-16 00:55 UTC by Mark Linimon
Modified: 2016-10-25 16:47 UTC (History)
1 user (show)

See Also:


Attachments
major patch to security/security.xml (9.49 KB, patch)
2016-10-16 00:55 UTC, Mark Linimon
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Mark Linimon freebsd_committer freebsd_triage 2016-10-16 00:55:12 UTC
Created attachment 175809 [details]
major patch to security/security.xml

This is part 3 of 3 different patches to the Security page on the website.  It is the most intrusive one.

There are two parts to this: the content changes, and the reordering.

The content changes are to reflect the fact that two different support models are defined in the page.  The text mostly stays the same, but is reworded to reflect, in order, "here is what the support model is now; but FYI, here is what the support model was previously".

The reordering changes consolidate existing text but adds more h2 subheadings, each with an entry in the new Table of Contents:

 * The TOC now switches places with Reporting FreeBSD Security Incidents, which becomes the first entry in the TOC.  (This is a little hard to see in the diff due to the other changes in the TOC.)

 * The next two items become Recent FreeBSD Security Advisories and Understanding FreeBSD Security Advisories.  The former existed as such; the latter text was buried down at the bottom of the page and had no header.  The text itself is mostly unchanged (see above).

 * The next section continues to be "How To Update Your System".

 * The next section continues to be "Supported Releases".  However, the paragraph including "the support model has been changed" and the 2 after it are moved below "Supported Releases" into a new section called "The FreeBSD Support Model."  Although the paragraphs are reordered, the content is mostly unchanged (see above).

 * The last section is the new "The FreeBSD Support Model", which only consolidates existing content.

So the overall page flow is: Security Incidents; Updating; Supported Releases; Support Model.

To me this makes the page flow much better, and assumes less knowledge on the part of a user unfamiliar with our procedures.
Comment 1 commit-hook freebsd_committer freebsd_triage 2016-10-25 16:35:31 UTC
A commit references this bug:

Author: gjb
Date: Tue Oct 25 16:35:19 UTC 2016
New revision: 49578
URL: https://svnweb.freebsd.org/changeset/doc/49578

Log:
  Refactor Security page for further clarity, and break
  into sections that can be directly linked.

  PR:		213526
  Submitted by:	linimon
  Sponsored by:	The FreeBSD Foundation

Changes:
  head/en_US.ISO8859-1/htdocs/security/security.xml
Comment 2 Glen Barber freebsd_committer freebsd_triage 2016-10-25 16:47:19 UTC
Committed, thanks.