1040235 - Documentation Updates

Status: RESOLVED FIXED

(Socorro :: General, task)

Description

[Trevor Bramwell :bramwelt]

This is the parent bug for multiple changes I think the documentation could benefit from. Feel free to disagree with any of the proposed changes, or expound on your whole hearted '+1' feelings.

Comment 1

[Trevor Bramwell :bramwelt]

http://cherrypy.readthedocs.org/en/latest/ Is a great example of where I'd like to see Socorro documentation get to. It's clean, simple, provides single word primary links, and even provides a Glossary.

Comment 2

[Robert Helmer [:rhelmer]]

(In reply to Trevor Bramwell :bramwelt from comment #1)
> http://cherrypy.readthedocs.org/en/latest/ Is a great example of where I'd
> like to see Socorro documentation get to. It's clean, simple, provides
> single word primary links, and even provides a Glossary.

+1 to this, looks very nice - amusingly, we have a bunch of old unlinked docs including a glossary apparently ;) http://socorro.readthedocs.org/en/latest/glossary.html

Comment 3

[Robert Helmer [:rhelmer]]

(In reply to Robert Helmer [:rhelmer] from comment #2)
> (In reply to Trevor Bramwell :bramwelt from comment #1)
> > http://cherrypy.readthedocs.org/en/latest/ Is a great example of where I'd
> > like to see Socorro documentation get to. It's clean, simple, provides
> > single word primary links, and even provides a Glossary.
> 
> +1 to this, looks very nice - amusingly, we have a bunch of old unlinked
> docs including a glossary apparently ;)
> http://socorro.readthedocs.org/en/latest/glossary.html

Actually that's linked from the developer docs! Could use some modernization obviously, parts of it are OK.

Comment 4

[Will Kahn-Greene [:willkg] ET needinfo? me]

All the bugs for this tracker have been resolved, so I'm going to close this as FIXED.