Documentation.

James Moger

2011-10-26 4c835e61e8ea2d5af2acf0c85c3c1f0d06f419df

Documentation.

 build.xml

@@ -258,7 +258,7 @@
                <arg value="index=overview" />



                <arg value="--alias" />

                <arg value="properties=gitblit.properties" />

                <arg value="properties=settings" />



                <arg value="--substitute" />

                <arg value="%VERSION%=${gb.version}" />

@@ -578,7 +578,7 @@
            <arg value="index=overview" />



            <arg value="--alias" />

            <arg value="properties=gitblit.properties" />

            <arg value="properties=settings" />



            <arg value="--substitute" />

            <arg value="%VERSION%=${gb.version}" />


 docs/00_index.mkd

@@ -36,6 +36,7 @@
- improved: summary page performance by caching metric calculations (issue 25)

- added: authenticated JSON RPC mechanism   

    **New:** *web.enableRpcServlet = true*  

    **New:** *web.enableRpcManagement = false*  
    **New:** *web.enableRpcAdministration = false*

- added: reusable JSON RPC client class

- added: Gitblit Manager (Java/Swing Application) for remote administration of a Gitblit server.


 docs/02_rpc.mkd

@@ -28,12 +28,13 @@
<tr><td>DELETE_USER</td><td>user name</td><td><em>admin</em></td><td>-</td><td>-</td></tr>

<tr><td>LIST_REPOSITORY_MEMBERS</td><td>repository name</td><td><em>admin</em></td><td>-</td><td>List&lt;String&gt;</td></tr>

<tr><td>SET_REPOSITORY_MEMBERS</td><td>repository name</td><td><em>admin</em></td><td>List&lt;String&gt;</td><td>-</td></tr>

<tr><td>LIST_SETTINGS</td><td>-</td><td><em>admin</em></td><td>-</td><td>ServerSettings (management keys)</td></tr>

<tr><td colspan='5'><em>web.enableRpcAdministration=true</em></td></tr>

<tr><td>LIST_FEDERATION_REGISTRATIONS</td><td>-</td><td><em>admin</em></td><td>-</td><td>List&lt;FederationModel&gt;</td></tr>

<tr><td>LIST_FEDERATION_RESULTS</td><td>-</td><td><em>admin</em></td><td>-</td><td>List&lt;FederationModel&gt;</td></tr>

<tr><td>LIST_FEDERATION_PROPOSALS</td><td>-</td><td><em>admin</em></td><td>-</td><td>List&lt;FederationProposal&gt;</td></tr>

<tr><td>LIST_FEDERATION_SETS</td><td>-</td><td><em>admin</em></td><td>-</td><td>List&lt;FederationSet&gt;</td></tr>

<tr><td colspan='5'><em>web.enableRpcAdministration=true</em></td></tr>

<tr><td>LIST_SETTINGS</td><td>-</td><td><em>admin</em></td><td>-</td><td>ServerSettings (see example below)</td></tr>

<tr><td>LIST_SETTINGS</td><td>-</td><td><em>admin</em></td><td>-</td><td>ServerSettings (all keys)</td></tr>

<tr><td>EDIT_SETTINGS</td><td>-</td><td><em>admin</em></td><td>Map&lt;String, String&gt;</td><td>-</td></tr>

<tr><td>LIST_STATUS</td><td>-</td><td><em>admin</em></td><td>-</td><td>ServerStatus (see example below)</td></tr>

</table>


 docs/04_releases.mkd

@@ -10,6 +10,7 @@
- improved: summary page performance by caching metric calculations (issue 25)

- added: authenticated JSON RPC mechanism   

    **New:** *web.enableRpcServlet = true*  

    **New:** *web.enableRpcManagement = false*  
    **New:** *web.enableRpcAdministration = false*

- added: reusable JSON RPC client class

- added: Gitblit Manager (Java/Swing Application) for remote administration of a Gitblit server.


 docs/05_roadmap.mkd

New file
@@ -0,0 +1,30 @@
## Roadmap



This is not exactly a formal roadmap but it is a priority list of what might be implemented in future releases.  
This list is volatile.



### TODO (high priority)



* Eclipse plugin to browse and clone repositories

* Support federation RPCs in Gitblit Manager



### TODO (medium priority)



* Editable settings page in GO/WAR

* Tag repositories and offer views of repositories by tag (issue 27)

* Aggregate RSS feeds by tag or subfolder

* Investigate create-on-push possibility

* Create Repository by Cloning feature (issue 5)

    * optional scheduled pulls

    * optional automatic push to origin/remotes?

    * optional manual push to origin/remotes?

* Lucene integration with multi-repository search (issue 16)



### TODO (low priority)



* Blame coloring by author (issue 2)

* View binary files in blob page (issue 6)



### IDEAS



* Stronger ticgit integration (issue 8)