opendev/gerrit
Code Issues Proposed changes

Documentation: Rebuild index page

Browse Source 
The index page already has sections, but I want to have a hierarchical index
rather than the current one.

I include a few new suggestions for topics that I believe are
missing from the docs today, mostly under End user guides and Server
administration.

The long term goal would be to rearrange the documents into folders
that correspond to the chapters suggested, and have this index auto-
generated by the build and put into a navbar that can be displayed on
all pages.

Change-Id: I908438ed7877cf9d657711d7349bb46a2876332f
Signed-off-by: Fredrik Luthander <fredrik.luthander@sonymobile.com>
This commit is contained in:
Fredrik Luthander 2013-05-08 11:26:41 +02:00
parent aef44b033d
commit 567d95b28a
1 changed files with 74 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

138
Documentation/index.txt
View File

@ -1,72 +1,82 @@
Gerrit Code Review for Git
==========================
Getting Started
---------------
Index
-----
* link:intro-quick.html[A Quick Introduction To Gerrit]
. General info
.. link:licenses.html[Licenses and Notices]
. Installing
.. link:intro-quick.html[A Quick Introduction To Gerrit]
.. link:install.html[Installation Guide]
. Tutorial
.. Get started
... External link: link:http://source.android.com/submit-patches/workflow[Default Android Workflow]
.. Web
... Registering a new Gerrit account
... 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]
.. 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: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
.. Plugins
.. link:dev-design.html[System Design]
.. link:config-contact.html[User Contact Information]
.. link:config-reverseproxy.html[Reverse Proxy]
.. link:pgm-index.html[Server Side Administrative Tools]
. Developer
.. link:dev-readme.html[Developer Setup]
.. 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:config-validation.html[Commit Validation]
. Maintainer
.. link:dev-release.html[Developer Release]
.. link:dev-release-subproject.html[Developer Subproject Release]
End User Guide
--------------
* External link: link:http://source.android.com/submit-patches/workflow[Default Android Workflow]
* link:user-search.html[Searching Changes]
* link:cmd-index.html[Command Line Tools]
* link:user-upload.html[Uploading Changes]
* link:user-changeid.html[Change-Id Lines]
* link:user-signedoffby.html[Signed-off-by Lines]
* link:error-messages.html[Error Messages]
* link:user-notify.html[Subscribing to Email Notifications]
Project Owner and Power User Guide
----------------------------------
* link:access-control.html[Access Controls]
* link:rest-api.html[REST API]
* link:user-dashboards.html[Dashboards]
* link:user-submodules.html[Subscribing to Git Submodules]
* link:prolog-cookbook.html[Prolog Cookbook]
* link:prolog-change-facts.html[Prolog Facts for Gerrit Changes]
* link:config-labels.html[Review Labels]
Admin User Guide
----------------
* link:pgm-index.html[Server Side Administrative Tools]
Installation
~~~~~~~~~~~~
* link:licenses.html[Licenses and Notices]
* link:install.html[Installation Guide]
* link:install-quick.html[Quick Installation in 10 Minutes]
* link:project-setup.html[Project Setup]
Configuration
~~~~~~~~~~~~~
* link:config-gerrit.html[System Settings]
* link:config-contact.html[User Contact Information]
* link:config-gitweb.html[Gitweb Integration]
* link:config-themes.html[Themes]
* link:config-sso.html[Single Sign-On Systems]
* link:config-reverseproxy.html[Reverse Proxy]
* link:config-hooks.html[Hooks]
* link:config-mail.html[Mail Templates]
* link:config-cla.html[Contributor Agreements]
Gerrit Developer Documentation
------------------------------
* link:dev-readme.html[Developer Setup]
* link:dev-eclipse.html[Eclipse Setup]
* link:dev-contributing.html[Contributing to Gerrit]
* link:dev-plugins.html[Developing Plugins]
* link:config-validation.html[Commit Validation]
* link:dev-design.html[System Design]
* link:i18n-readme.html[i18n Support]
* link:dev-release.html[Developer Release]
* link:dev-release-subproject.html[Developer Subproject Release]
Resources
---------