Fix references provided as lists of URLs

Bug #1343480 reported by Bryan D. Payne
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Wishlist
Priti Desai

Bug Description

In the security guide, there are several areas where we list many references that are just URLs as a bulleted list at the end of a chapter. Such lists do not display properly in a printed version of the book (the URL may be masked and just the link name displayed). And these URLs can quickly go stale or become out of date.

Recommendation is to work to replace these references with published works that have longer lasting references. And then to improve how these are referenced within the book. This could be by either using a more traditional bibliography format at the end of each chapter or at the end of the entire book.

Changed in openstack-manuals:
status: New → Confirmed
importance: Undecided → Low
tags: added: low-hanging-fruit
Changed in openstack-manuals:
assignee: nobody → Rudrajit Tapadar (rtapadar)
Changed in openstack-manuals:
assignee: Rudrajit Tapadar (rtapadar) → nobody
Changed in openstack-manuals:
assignee: nobody → Joseph Robinson (joseph-r-email)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to security-doc (master)

Fix proposed to branch: master
Review: https://review.openstack.org/129791

Changed in openstack-manuals:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to security-doc (master)

Reviewed: https://review.openstack.org/129791
Committed: https://git.openstack.org/cgit/openstack/security-doc/commit/?id=ce11cf8f0263babf650f019437272cb6daab3f58
Submitter: Jenkins
Branch: master

commit ce11cf8f0263babf650f019437272cb6daab3f58
Author: Joseph Robinson <email address hidden>
Date: Tue Oct 21 15:15:25 2014 +1000

    Security Guide reference list update

    Changing the bulleted list of reference URLs included in
    chapters 8, 14, 15, and 17 into a bibliography format.

    Change-Id: Ie3b061d74d806d01aa365712700bbc05b2792410
    backport: icehouse
    Partial-bug: #1343480

Tom Fifield (fifieldt)
Changed in openstack-manuals:
status: In Progress → Triaged
importance: Low → Wishlist
assignee: Joseph Robinson (joseph-r-email) → nobody
Revision history for this message
Bryan D. Payne (bdpayne) wrote :

Would be nice to fill out this ticket with details of where we need to make this fixes. Perhaps even break this into multiple tickets. That will help to make this more actionable.

Ju Lim (julim)
Changed in openstack-manuals:
assignee: nobody → Ju Lim (julim)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to security-doc (master)

Fix proposed to branch: master
Review: https://review.openstack.org/183953

Changed in openstack-manuals:
status: Triaged → In Progress
Tom Fifield (fifieldt)
Changed in openstack-manuals:
milestone: none → liberty
Lana (loquacity)
Changed in openstack-manuals:
status: In Progress → Confirmed
Changed in openstack-manuals:
milestone: liberty → mitaka
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Change abandoned on security-doc (master)

Change abandoned by Lana Brindley (<email address hidden>) on branch: master
Review: https://review.openstack.org/183953
Reason: Patch needs to be done in RST.

Changed in openstack-manuals:
assignee: Ju Lim (julim) → nobody
Changed in openstack-manuals:
assignee: nobody → Priti Desai (priti-desai)
Revision history for this message
Priti Desai (priti-desai) wrote :

This issue can be resolved if we can fix following issues:

(1) This list of sections has a separate section called "References":

http://docs.openstack.org/security-guide/data-processing/configuration-and-hardening.html
http://docs.openstack.org/security-guide/management/continuous-systems-management.html
http://docs.openstack.org/security-guide/management/management-interfaces.html

Lets be consistent and convert the "References" section into "Bibliography".

(2) Also, run a web crawler against entire guide to find dead URLs and fix them.

(3) Optional, reapply this patch https://review.openstack.org/183953

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to security-doc (master)

Fix proposed to branch: master
Review: https://review.openstack.org/275963

Changed in openstack-manuals:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to security-doc (master)

Reviewed: https://review.openstack.org/275963
Committed: https://git.openstack.org/cgit/openstack/security-doc/commit/?id=407f8262d2beae144b88b5322c3990d5622b4233
Submitter: Jenkins
Branch: master

commit 407f8262d2beae144b88b5322c3990d5622b4233
Author: Priti Desai <email address hidden>
Date: Wed Feb 3 14:42:55 2016 -0800

    Converting references to bibliography

    Converting "References" to "Bibliography":

    http://docs.openstack.org/security-guide/data-processing/configuration-and-hardening.html
    http://docs.openstack.org/security-guide/management/continuous-systems-management.html
    http://docs.openstack.org/security-guide/management/management-interfaces.html

    Also, reapplying this patch https://review.openstack.org/183953,
    fixing python paste link.

    Change-Id: Ibab3bfe92192e2d29b0a102829a7a3dcde73e7ae
    Partial-Bug: #1343480

Revision history for this message
Priti Desai (priti-desai) wrote :
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to security-doc (master)

Fix proposed to branch: master
Review: https://review.openstack.org/276491

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to security-doc (master)

Reviewed: https://review.openstack.org/276491
Committed: https://git.openstack.org/cgit/openstack/security-doc/commit/?id=f9d3622921bc0f87ee5f71e9ea0fa7940d980fe1
Submitter: Jenkins
Branch: master

commit f9d3622921bc0f87ee5f71e9ea0fa7940d980fe1
Author: Priti Desai <email address hidden>
Date: Thu Feb 4 15:04:43 2016 -0800

    Fixing broken links

    Fixing references which were dead links at:

    http://docs.openstack.org/security-guide/compute/hypervisor-selection.html
    http://docs.openstack.org/security-guide/compliance/overview.html

    Change-Id: I88254df5d98705285bce7a7159373a2ee40350df
    Closes-bug: #1343480

Changed in openstack-manuals:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.