suggest we add table of contents to web documentation

Bug #1419863 reported by James Hunt
10
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ubuntu Developer Portal
Fix Released
Medium
Daniel Holbach
ubuntu-website-content
Fix Released
Medium
Peter Mahnke

Bug Description

We currently have two main (and excellent) pages on snappy:

1) http://www.ubuntu.com/things
2) https://developer.ubuntu.com/en/snappy

However, they are both extremely long documents (one is 19 screenfuls on my monitor, the other 15 screenfuls).

- Document (1) has no table of contents.
- Document (2) does sort of have a table of contents at the top, but only 2 of the links jump to within the document (#tour and #snap-developers) and it is not clear from the presentation that the other links are actually external links.

Please can we consider:

a) Adding well structured Table of Contents (ToC's) to both documents.
b) Adding some sort of visual clue that some links are internal whilst other are external.

Suggestion: Add a hideable/toggleable ToC in the [huge] margins.

Revision history for this message
Alexander Sack (asac) wrote :

subscribed peter and dpm to comment/think about this.

Revision history for this message
Peter Mahnke (peterm-ubuntu) wrote :

for ubuntu.com we don't have a pattern for tables of contents, I don't really think it fits with the site.

personally I think we should make the page simpler in the following ways:

1. move the partners into a new 'snappy' programme on partners.ubuntu.com
2. display a rotating list of these partner logos on ubuntu.com/things
3. move 'Getting started with a Beaglebone Black' to a new page on developer.ubuntu.com
4. move 'WebDM: The web device manager' to a new page on developer.ubuntu.com

Revision history for this message
Daniel Holbach (dholbach) wrote :

I'm taking care of 3 and 4.

I'll open a bug task for developer-ubuntu-com - and we can move the current one to ubuntu-website-content.

Changed in developer-ubuntu-com:
assignee: nobody → Daniel Holbach (dholbach)
importance: Undecided → Medium
status: New → In Progress
affects: snappy-ubuntu → ubuntu-website-content
Revision history for this message
Daniel Holbach (dholbach) wrote :
Revision history for this message
Daniel Holbach (dholbach) wrote :
Changed in developer-ubuntu-com:
status: In Progress → Fix Released
Changed in ubuntu-website-content:
status: New → Fix Released
assignee: nobody → Peter Mahnke (peterm-ubuntu)
importance: Undecided → Medium
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.