gerrit/Documentation/index.txt
Edwin Kempin 4fd84c9051 Add documentation with screenshots for the new review UIs
The new review UI documentation should describe the new change screen
and the new side-by-side diff screen. It provides screenshots in which
the described UI elements are highlighted so that users can easily
find the described functionality in the UI. This documentation is
based on the description of the new screens in the 'What’s new in
Gerrit 2.9' presentation that was shown at the Gerrit User Summit
2014. With this change only the commit message block and the commit
info block are documented. Follow-up changes will document the other
UI elememts. Once the new documentation is ready it should replace
new change screen introduction that is already contained in the
documentation. This guide is purely text-base and hence more difficult
to consume for users.

[1] http://storage.googleapis.com/gerrit-talks/gerrit-new-features-2.9.html

Change-Id: I5dcae829b091d405b9cd6774d63dba869b059f75
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
2014-05-02 13:03:35 +02:00

96 lines
3.4 KiB
Plaintext

= Gerrit Code Review for Git
== Tutorial
. Getting started
.. link:intro-quick.html[A Quick Introduction to Gerrit]
.. link:intro-change-screen.html[A Quick Introduction to the New Change Screen]
.. 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-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-setup.html[Project Setup]
. 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:https://gerrit-review.googlesource.com/#/admin/projects/?filter=plugins%252F[Plugins]
. link:dev-design.html[System Design]
. 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
. link:dev-readme.html[Developer Setup]
. link:dev-buck.html[Building with Buck]
. link:dev-build-plugins.html[Building Gerrit plugins]
. link:dev-eclipse.html[Eclipse Setup]
. link:dev-contributing.html[Contributing to Gerrit]
. Documentation formatting guide for contributions
. link:dev-design.html[System Design]
. link:i18n-readme.html[i18n Support]
. Plugin development
.. link:dev-plugins.html[Developing Plugins]
.. link:js-api.html[JavaScript Plugin API]
.. link:config-validation.html[Commit Validation]
== 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
---------