gerrit/Documentation/index.txt
Edwin Kempin 1f55622e6f Add user guide
Add a new documentation guide for end users that explains them how to
work with Gerrit and how Gerrit can be adapted to personal
preferences. So far there is no single documentation page that new
Gerrit users could check to learn about Gerrit. Most of the
information is available in the documentation somewhere, but it's hard
to discover and for new users almost impossible to find without
reading the whole documentation.

Change-Id: I93f433d8705bd5e2b37115df2df63a47557e2cb3
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
2015-04-30 14:37:09 +00:00

97 lines
3.3 KiB
Plaintext

= Gerrit Code Review for Git
== Tutorial
. Getting started
.. link:intro-quick.html[A Quick Introduction to Gerrit]
.. link:intro-user.html[User Guide]
.. link:intro-project-owner.html[Project Owner Guide]
.. link:http://source.android.com/submit-patches/workflow[Default Android Workflow] (external)
. Web
.. Registering a new Gerrit account
.. link:user-review-ui.html[Reviewing Changes]
.. link:user-search.html[Searching Changes]
.. link:user-inline-edit.html[Manipulating Changes in Browser]
.. link:user-notify.html[Subscribing to Email Notifications]
. SSH
.. SSH connection details
.. link:cmd-index.html[Command Line Tools]
. Git
.. Git connection details
.. Commands, scenarios
... link:user-upload.html[Uploading Changes]
... link:error-messages.html[Error Messages]
.. Changes
... link:user-changeid.html[Change-Id Lines]
... link:user-signedoffby.html[Signed-off-by Lines]
.. Patch sets
== Project Management
. link:project-configuration.html[Project Configuration]
. link:access-control.html[Access Controls]
.. link:config-labels.html[Review Labels]
.. link:config-project-config.html[Access Controls Configuration Format]
. Multi-project management
.. Submodules
.. Repo
. Prolog rules
.. link:prolog-cookbook.html[Prolog Cookbook]
.. link:prolog-change-facts.html[Prolog Facts for Gerrit Changes]
. link:user-submodules.html[Subscribing to Git Submodules]
. Project sunset
== Customization and Integration
. link:user-dashboards.html[Dashboards]
. link:rest-api.html[REST API]
. link:config-gitweb.html[Gitweb Integration]
. link:config-themes.html[Themes]
. link:config-sso.html[Single Sign-On Systems]
. link:config-hooks.html[Hooks]
. link:config-mail.html[Mail Templates]
. link:config-cla.html[Contributor Agreements]
== Server Administration
. link:install.html[Installation Guide]
. link:config-gerrit.html[System Settings]
. Backup
. Performance tuning
.. link:cmd-index.html[Command Line Tools]
.. Reading show-caches efficiently
.. How to read stats from the JVM
. High availability
. Replication
. link:config-plugins.html[Plugins]
. link:config-contact.html[User Contact Information]
. link:config-reverseproxy.html[Reverse Proxy]
. link:config-auto-site-initialization.html[Automatic Site Initialization on Startup]
. link:pgm-index.html[Server Side Administrative Tools]
== Developer
. Getting Started
.. link:dev-readme.html[Developer Setup]
.. link:dev-eclipse.html[Eclipse Setup]
.. link:dev-buck.html[Building with Buck]
.. link:dev-contributing.html[Contributing to Gerrit]
. Plugin Development
.. link:dev-plugins.html[Developing Plugins]
.. link:dev-build-plugins.html[Building Gerrit plugins]
.. link:js-api.html[JavaScript Plugin API]
.. link:config-validation.html[Validation Interfaces]
. Documentation formatting guide for contributions
. link:dev-design.html[System Design]
. link:i18n-readme.html[i18n Support]
== Maintainer
. link:dev-release.html[Developer Release]
. link:dev-release-subproject.html[Developer Subproject Release]
== Resources
* link:licenses.html[Licenses and Notices]
* link:http://code.google.com/p/gerrit/[Homepage]
* link:http://gerrit-releases.storage.googleapis.com/index.html[Downloads]
* link:http://code.google.com/p/gerrit/issues/list[Issue Tracking]
* link:http://code.google.com/p/gerrit/source/checkout[Source Code]
* link:http://code.google.com/p/gerrit/wiki/Background[A History of Gerrit Code Review]
SEARCHBOX
---------