From d65f712ea3d8941f4b9145c0630c30c20af80d13 Mon Sep 17 00:00:00 2001 From: James Moger Date: Fri, 11 Nov 2011 17:22:21 -0500 Subject: [PATCH] Documentation. Add javadoc and source jars to the gbapi download. --- .gitignore | 1 + build.xml | 59 ++++++++++++++++++++++++++++++++++++++------ docs/01_features.mkd | 8 +++--- docs/05_roadmap.mkd | 16 ++++++++++-- 4 files changed, 70 insertions(+), 14 deletions(-) diff --git a/.gitignore b/.gitignore index 3c0210d0..9074474f 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,4 @@ /src/WEB-INF/reference.properties /bin/ /.settings/ +/javadoc diff --git a/build.xml b/build.xml index 52d9d94e..8ba2b5a5 100644 --- a/build.xml +++ b/build.xml @@ -85,7 +85,7 @@ - + @@ -274,7 +274,7 @@ - + @@ -422,6 +422,8 @@ + + @@ -438,7 +440,7 @@ Building Gitblit Manager ${gb.version} - + @@ -478,6 +480,14 @@ + + + + + + + + + + @@ -501,10 +513,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + @@ -634,7 +677,7 @@ - + @@ -721,8 +764,8 @@ username="${googlecode.user}" password="${googlecode.password}" projectname="gitblit" - filename="${manager.jarfile}" - targetfilename="manager-${gb.version}.jar" + filename="${manager.zipfile}" + targetfilename="manager-${gb.version}.zip" summary="Gitblit Manager v${gb.version} (Swing tool to remotely administer a Gitblit server)" labels="Featured, Type-Package, OpSys-All" /> diff --git a/docs/01_features.mkd b/docs/01_features.mkd index 927df892..9b1c9a68 100644 --- a/docs/01_features.mkd +++ b/docs/01_features.mkd @@ -16,17 +16,17 @@ Gitblit can be used as a complete Git stack for cloning, pushing, and repository ### Easy Web Management Administrators can create and manage all repositories & user accounts from the *web UI*. -Administrators can create and manage all repositories & user accounts from the *JSON RPC interface* using the [Gitblit Manager](%MANAGER%) or your own custom tooling. +Administrators can create and manage all repositories & user accounts from the *JSON RPC interface* using the [Gitblit Manager](http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%) or your own custom tooling. ### Integration Gitblit has a pluggable user service mechanism which allows you to implement your own authentication, authorization, and user management. -Gitblit offers RSS feeds, a JSON-based RPC mechanism, and a [Java client API library](%API%) which allow you to integrate Gitblit into your systems. +Gitblit offers RSS feeds, a JSON-based RPC mechanism, and a [Java Client API library](http://code.google.com/p/gitblit/downloads/detail?name=%API%) which allows you to integrate Gitblit into your systems. ### Backup Strategy -Gitblit includes a backup mechanism (*federation*) which can be used to backup repositories and, optionally, user accounts & server settings from your Gitblit instance to another Gitblit instance or to a [Gitblit Federation Client](%FEDCLIENT%). Similarly you can use the federation mechanism to aggregate individual workspace Gitblit instances to a common, centralized server. +Gitblit includes a backup mechanism (*federation*) which can be used to backup repositories and, optionally, user accounts & server settings from your Gitblit instance to another Gitblit instance or to a [Gitblit Federation Client](http://code.google.com/p/gitblit/downloads/detail?name=%FEDCLIENT%). Similarly, you can use the federation mechanism to aggregate individual workspace Gitblit instances to a common, centralized server. ## Standard Features (GO/WAR) @@ -69,7 +69,7 @@ Gitblit includes a backup mechanism (*federation*) which can be used to backup r - A Windows service installation script and configuration tool ## Limitations -- HTTP/HTTPS are the only supported protocols +- HTTP/HTTPS are the only supported Git protocols - Access controls are not path-based, they are repository-based - Only Administrators can create, rename or delete repositories - Only Administrators can create, modify or delete users diff --git a/docs/05_roadmap.mkd b/docs/05_roadmap.mkd index 237952b1..b29f622e 100644 --- a/docs/05_roadmap.mkd +++ b/docs/05_roadmap.mkd @@ -13,14 +13,24 @@ This list is volatile. * Gitblit: editable settings page in GO/WAR * Gitblit: tag repositories and offer views of repositories by tag (issue 27) -* Gitblit: aggregate RSS feeds by tag or subfolder -* Gitblit: investigate create-on-push possibility +* Gitblit: investigate create-repository-on-push. + * Maybe a new user role to allow this? + * Maybe a server setting to disable this completely? + * Pusher/Creator becomes repository owner and can then manipulate access lists, etc? * Gitblit: Clone Repository feature (issue 5) * optional scheduled pulls * optional automatic push to origin/remotes? * optional manual push to origin/remotes? * Gitblit: Lucene integration with multi-repository search (issue 16) * Gitblit: Repository regex substitutions should be stored in .git/.config, not gitblit.properties +* Gitblit: Consider allowing git:// protocol using JGit + * new setting *git.allowGitProtocol* to enable/disable git:// protocol + * unrestricted repositories would have anonymous RW git:// access + * push-restricted repositories would have anonymous R git:// access + * clone-restricted repositories would prohibit git:// access + * view-restricted repositories would prohibit git:// access +* Gitblit: Consider using Git-style config file instead of Java properties file for user storage (users.config vs. users.properties) + * this would allow for additional fields per user without bringing in a database ### TODO (low priority) @@ -29,4 +39,6 @@ This list is volatile. ### IDEAS +* Gitblit: aggregate RSS feeds by tag or subfolder +* Gitblit: Consider creating more Git model objects and exposing them via the JSON RPC interface to allow inspection/retrieval of Git commits, Git trees, etc from Gitblit. * Gitblit: Stronger ticgit integration (issue 8) -- 2.39.5