From 4c835e61e8ea2d5af2acf0c85c3c1f0d06f419df Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Wed, 26 Oct 2011 17:19:55 -0400
Subject: [PATCH] Documentation.
---
docs/02_rpc.mkd | 5 +++--
docs/04_releases.mkd | 1 +
build.xml | 4 ++--
docs/00_index.mkd | 1 +
docs/05_roadmap.mkd | 30 ++++++++++++++++++++++++++++++
5 files changed, 37 insertions(+), 4 deletions(-)
diff --git a/build.xml b/build.xml
index 4a5c886..d6dcbf0 100644
--- a/build.xml
+++ b/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}" />
diff --git a/docs/00_index.mkd b/docs/00_index.mkd
index 4aea0d7..0985075 100644
--- a/docs/00_index.mkd
+++ b/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.
diff --git a/docs/02_rpc.mkd b/docs/02_rpc.mkd
index 6384862..13bf8ef 100644
--- a/docs/02_rpc.mkd
+++ b/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<String></td></tr>
<tr><td>SET_REPOSITORY_MEMBERS</td><td>repository name</td><td><em>admin</em></td><td>List<String></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<FederationModel></td></tr>
<tr><td>LIST_FEDERATION_RESULTS</td><td>-</td><td><em>admin</em></td><td>-</td><td>List<FederationModel></td></tr>
<tr><td>LIST_FEDERATION_PROPOSALS</td><td>-</td><td><em>admin</em></td><td>-</td><td>List<FederationProposal></td></tr>
<tr><td>LIST_FEDERATION_SETS</td><td>-</td><td><em>admin</em></td><td>-</td><td>List<FederationSet></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<String, String></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>
diff --git a/docs/04_releases.mkd b/docs/04_releases.mkd
index ac09778..50612e6 100644
--- a/docs/04_releases.mkd
+++ b/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.
diff --git a/docs/05_roadmap.mkd b/docs/05_roadmap.mkd
new file mode 100644
index 0000000..65ef8ae
--- /dev/null
+++ b/docs/05_roadmap.mkd
@@ -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)
--
Gitblit v1.9.1