loggerhead needs some (more) documentation

Bug #419719 reported by Martin Pool
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
loggerhead
Triaged
Low
Unassigned
loggerhead-breezy
Triaged
Low
Unassigned

Bug Description

I like loggerhead: very slick. Only problem is I can't find decent documentation on it anywhere. As a result, I'm not really clear on some of the concepts of the program, or how it works. I'm not really sure of what is possible with it and what is not. I don't know how to properly configure it, or personalize the interface.

Is there a Loggerhead manual? If not, I'd advice you to create one: it will definitely save you time in the future from having to answer questions (like this one).

Many thanks for your hard work.

Redge

Revision history for this message
Martin Pool (mbp) wrote :

Yeah, Launchpad does, but that's not what we're here for in 419719 :)

summary: - launchpad needs some (more) documentation
+ loggerhead needs some (more) documentation
Redge (redgetrek)
description: updated
Revision history for this message
Tres Seaver (tseaver) wrote :

I would recommend adding a 'docs' subdirectory in the main directory, populated initially with 'sphinx-quickstart' and copying the various bits from the man pages and README for a starting point. In fact, I will upload such a branch and ask for a merge.

Others can then help improve / translate the docs using bzr.

Revision history for this message
Tres Seaver (tseaver) wrote :

Branch with Sphinx docs:

 lp:~tseaver/loggerhead/sphinxify

Changed in loggerhead:
status: New → Triaged
importance: Undecided → Low
Jelmer Vernooij (jelmer)
Changed in loggerhead-breezy:
status: New → Triaged
importance: Undecided → Low
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Related questions

Remote bug watches

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