Bug 89917

Summary:	Telepathy has no online documentation
Product:	Telepathy	Reporter:	Hristo Venev <hristo>
Component:	tp-doc	Assignee:	Telepathy bugs list <telepathy-bugs>
Status:	RESOLVED FIXED	QA Contact:	Telepathy bugs list <telepathy-bugs>
Severity:	normal
Priority:	medium
Version:	git master
Hardware:	Other
OS:	All
Whiteboard:
i915 platform:		i915 features:

Description Hristo Venev 2015-04-06 14:12:44 UTC

As of 2015-04-06 telepathy has no recent online documentation whatsoever. This makes it very difficult to develop anything with it.

It would be good to publish a pre-built HTML version of the book from the telepathy-docs repository. It currently fails to build because of syntax errors in docs/book/insert-*.py. It depends on inkscape and lxml so it's not extremely trivial to build them.

It would also be good to publish a pre-built HTML version of the specification from the telepathy-spec repository. It currently fails to build because of syntax errors in tools/doc-generator.py. It also depends on cheetah which is unmaintained and also contains many syntax errors so it's even less trivial to build it.

Comment 1 George Kiagiadakis 2016-07-13 10:03:22 UTC

This is not true. The documentation was never offline. The only problem was that the wiki pages linking to the documentation were erased (due to a spam bot attack and wiki conversion later).

The wiki issue has been addressed now, and will continue being improved.

For the record, you can browse all the documentation from:
https://telepathy.freedesktop.org/doc/

The book can be found here: https://telepathy.freedesktop.org/doc/book/
...and the spec here: https://telepathy.freedesktop.org/spec/

I was not aware of the build issues (although I recently built the spec without any problems), but these deserve different bug reports. I will keep this in mind.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.