[Freeipa-devel] [PATCH] 451-458 Web UI devel and source code documentation

[Petr Vobornik]

Hello,

This is a part of documentation effort which started couple month ago. 
Attached patches improves devel documentation of Web UI. Mostly by 
annotating source code and then processing it by JSDuck tool[1].

The documentation is not complete - most plugins and member of some core 
widgets and facets are not annotated yet. I'm sending it now because I 
need to focus on more pressing tickets.

You can see current state at my fedorapeople page [2].

I also converted 5 guides/articles which I wrote some time ago. Guides 
are also part of the JSDuck app [3].

The idea is to regularly generate the doc and place it on 
docs.freeipa.org (not in production at the moment) so all doc would be 
on one place.

Installation of JSDuck is documented on their page [4]. Basically it 
requires ruby and JSDuck gem.

Usage:
$ cd install/ui/doc
$ make

Documentation is generated into: install/ui/build/code_doc directory

[1] https://github.com/senchalabs/jsduck
[2] http://pvoborni.fedorapeople.org/doc
[3] http://pvoborni.fedorapeople.org/doc/#!/guide
[4] https://github.com/senchalabs/jsduck/wiki/Installation
-- 
Petr Vobornik
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0451-Removal-of-unused-code.patch
Type: text/x-patch
Size: 1211 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20130911/0c19c0a9/attachment.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0452-Web-UI-source-code-annotation.patch
Type: text/x-patch
Size: 316040 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20130911/0c19c0a9/attachment-0001.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0453-Configuration-for-JSDuck-documentation-generator.patch
Type: text/x-patch
Size: 9529 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20130911/0c19c0a9/attachment-0002.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0454-Phases-Guide.patch
Type: text/x-patch
Size: 9671 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20130911/0c19c0a9/attachment-0003.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0455-Debugging-Web-UI-guide.patch
Type: text/x-patch
Size: 6324 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20130911/0c19c0a9/attachment-0004.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0456-Plugin-Infrastructure-Guide.patch
Type: text/x-patch
Size: 5022 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20130911/0c19c0a9/attachment-0005.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0457-Navigation-Guide.patch
Type: text/x-patch
Size: 15630 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20130911/0c19c0a9/attachment-0006.bin>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: freeipa-pvoborni-0458-Registries-and-Build-Guide.patch
Type: text/x-patch
Size: 12664 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/freeipa-devel/attachments/20130911/0c19c0a9/attachment-0007.bin>