From 4ef60d7a963fdadaa69db98df7844314c2ceb693 Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Sat, 12 Nov 2011 09:01:25 -0500
Subject: [PATCH] Documentation.
---
docs/00_index.mkd | 107 +++++++++++++++++++++++++++--------------------------
1 files changed, 54 insertions(+), 53 deletions(-)
diff --git a/docs/00_index.mkd b/docs/00_index.mkd
index 7916fe6..4e6645e 100644
--- a/docs/00_index.mkd
+++ b/docs/00_index.mkd
@@ -1,66 +1,67 @@
-## Overview
-<a href="screenshots.html" title="Screenshots"><img class="overview" src="thumbs/00.png" alt="Screenshots" /></a>
+## What is Gitblit?
+<div class="well" style="float:right;padding: 14px 14px;">
+<b>Current Release %VERSION% (%BUILDDATE%)</b> <a href="releases.html">changelog</a>
+<div style="padding:5px;"><a style="text-decoration:none;" class="btn success" href="http://code.google.com/p/gitblit/downloads/detail?name=%GO%">Download Gitblit GO</a></div>
+<div style="padding:5px;"><a style="text-decoration:none;" class="btn danger" href="http://code.google.com/p/gitblit/downloads/detail?name=%WAR%">Download Gitblit WAR</a></div>
+<div style="padding:5px;"><a style="text-decoration:none;" class="btn primary" href="http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%">Download Gitblit Manager</a></div>
+ <div style="text-align:center;">
+ <a href="http://code.google.com/p/gitblit/downloads/detail?name=%API%">Gitblit API</a> | <a href="http://code.google.com/p/gitblit/downloads/detail?name=%FEDCLIENT%">Gitblit Federation Client</a>
+ <br/>
+ <a href="screenshots.html" title="Screenshots"><img style="margin-top:5px;border:1px solid #ccc;" src="thumbs/00.png" alt="Screenshots" /></a>
+ </div>
+</div>
-Gitblit is an open-source, pure Java stack for managing, viewing, and serving [Git][git] repositories.<br/>
-Its designed primarily as a tool for small workgroups who want to host centralized repositories.
+Gitblit is an open-source, pure Java stack for managing, viewing, and serving [Git][git] repositories.
+It's designed primarily as a tool for small workgroups who want to host centralized repositories.
-Gitblit is available in two variations:
+### GO: Single-Stack Solution
-1. *Gitblit GO* - a complete & integrated pure Java stack
+*Gitblit GO* is an integrated, single-stack solution based on Jetty.
+
+You do not need Apache httpd, Perl, Git, or Gitweb. Should you want to use some or all of those, you still can; Gitblit plays nice with the other kids on the block.
+
+This is what you should download if you want to go from zero to Git in less than 5 mins.
+
+All dependencies are downloaded on first execution.
+
+### WAR: For Your Servlet Container
+*Gitblit WAR* is what you should download if you already have a servlet container available that you wish to use.
+Jetty 6/7/8 and Tomcat 6/7 are known to work. Generally, any Servlet 2.5 or Servlet 3.0 container should work.
- This is what you should download if you want to go from zero to Git in less than 5 mins.
- Gitblit GO is like a mashup of Apache httpd, [Git][git], and Gitweb with simplified configuration and maintenance.
- All dependencies are downloaded on first execution.
-2. *Gitblit WAR* - a traditional WAR distribution
-
- This is what you should download if you want to deploy Gitblit into your own servlet container (e.g. Tomcat, Jetty, etc).
- All dependencies are bundled.
+All dependencies are bundled.
-### Tools
+### You decide how to use Gitblit
-- *Gitblit API* - an RSS/JSON RPC client library for integrating Gitblit into your systems
-- *Gitblit Manager* - a Java/Swing application for remote administration of a Gitblit server which uses the Gitblit API library
-- *Gitblit Federation Client* - a command line tool to clone/pull groups of repositories and optionally users and settings
+Gitblit can be used as a dumb repository viewer with no administrative controls or user accounts.
+Gitblit can be used as a complete Git stack for cloning, pushing, and repository access control.
+Gitblit can be used without any other Git tooling (including actual Git) or it can cooperate with your established tools.
+
+### 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](http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%) or your own custom tooling.
+
+### Integration and Mining
+
+- Pluggable user service mechanism for custom authentication, authorization, and user management
+- Rich RSS feeds
+- JSON-based RPC mechanism
+- [Java Client API library](http://code.google.com/p/gitblit/downloads/detail?name=%API%) for custom integration
+
+### 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](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.
+
+### Project Management and Community
+
+issues, binaries, and sources @ [Google Code][googlecode]
+sources @ [Github][gitbltsrc]
+group discussion @ the [Gitblit Discussion Group](http://groups.google.com/group/gitblit)
+follow Gitblit @ [google+](https://plus.google.com/114464678392593421684)
### Java Runtime Requirement
Gitblit requires a Java 6 Runtime Environment (JRE) or a Java 6 Development Kit (JDK).
-
-### Current Release
-
-**%VERSION%** ([go](http://code.google.com/p/gitblit/downloads/detail?name=%GO%) | [war](http://code.google.com/p/gitblit/downloads/detail?name=%WAR%) | [fedclient](http://code.google.com/p/gitblit/downloads/detail?name=%FEDCLIENT%) | [manager](http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%) | [api](http://code.google.com/p/gitblit/downloads/detail?name=%API%)) based on [%JGIT%][jgit] *released %BUILDDATE%*
-
-- **security**: fixed security hole when cloning clone-restricted repository with TortoiseGit (issue 28)
-- improved: updated ui with Twitter's Bootstrap CSS toolkit
- **New:** *web.loginMessage = gitblit*
-- improved: repositories list performance by caching repository sizes (issue 27)
-- 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: Gitblit API RSS/JSON RPC library
-- added: Gitblit Manager (Java/Swing Application) for remote administration of a Gitblit server.
-- added: per-repository setting to skip size calculation (faster repositories page loading)
-- added: per-repository setting to skip summary metrics calculation (faster summary page loading)
-- added: IUserService.setup(IStoredSettings) for custom user service implementations
-- added: setting to control Gitblit GO context path for proxy setups
- **New:** *server.contextPath = /*
-- added: *combined-md5* password storage option which stores the hash of username+password as the password
-- fixed: federation protocol timestamps. dates are now serialized to the [iso8601](http://en.wikipedia.org/wiki/ISO_8601) standard.
- **This breaks 0.6.0 federation clients/servers.**
-- fixed: collision on rename for repositories and users
-- fixed: Gitblit can now browse the Linux kernel repository (issue 25)
-- fixed: Gitblit now runs on Servlet 3.0 webservers (e.g. Tomcat 7, Jetty 8) (issue 23)
-- fixed: Set the RSS content type of syndication feeds for Firefox 4 (issue 22)
-- fixed: RSS feeds are now properly encoded to UTF-8
-- fixed: RSS feeds now properly generate parameterized links if *web.mountParameters=false*
-- fixed: Null pointer exception if did not set federation strategy (issue 20)
-- fixed: Gitblit GO allows SSL renegotiation if running on Java 1.6.0_22 or later
-- updated: MarkdownPapers 1.2.5
-
-issues, binaries, and sources @ [Google Code][googlecode]<br/>
-sources @ [Github][gitbltsrc]
### License
Gitblit is distributed under the terms of the [Apache Software Foundation license, version 2.0][apachelicense]
--
Gitblit v1.9.1