| commit | a9c529faa8cf014763aa6d917641daf1ea22a830 | [log] [tgz] |
|---|---|---|
| author | Edwin Kempin <ekempin@google.com> | Thu Jun 17 09:34:24 2021 +0200 |
| committer | Edwin Kempin <ekempin@google.com> | Thu Jun 17 09:43:14 2021 +0200 |
| tree | 1191e50e747ef82c0e698b5b77684f45b2e87f0e | |
| parent | 38d9e49985109c9dc42b97b714540f2fefa5f4a2 [diff] |
Allow plugins to maintain the TOC section of the index page manually Usually the index page of a plugin is automatically generated. The generated index page has 3 sections: 1. manifest section 2. about section 3. TOC section The TOC section is generated by scanning every *.md and *.html file in the Documentation/ directory. Depending on the file names the found pages are sorted into some static sections (SSH commands, REST API, Servlet, Documentation). Often these static sections are not the best grouping of documentation pages, e.g. grouping pages by target group (User vs. Admin) might be better. In addition, the sorting of the pages is alphabetically, but it might be better to sort them by importance. With this change plugins can maintain the TOC section manually by including a toc.md or toc.html file. If such a file is present its content will be included into the TOC section of the generated index page, instead of generating it. Signed-off-by: Edwin Kempin <ekempin@google.com> Change-Id: I7e740b58c47ac758efec340e0ca0021c0c7df576
Gerrit is a code review and project management tool for Git based projects.
Gerrit makes reviews easier by showing changes in a side-by-side display, and allowing inline comments to be added by any reviewer.
Gerrit simplifies Git based project maintainership by permitting any authorized user to submit changes to the master Git repository, rather than requiring all approved changes to be merged in by hand by the project maintainer.
For information about how to install and use Gerrit, refer to the documentation.
Our canonical Git repository is located on googlesource.com. There is a mirror of the repository on Github.
Please report bugs on the issue tracker.
Gerrit is the work of hundreds of contributors. We appreciate your help!
Please read the contribution guidelines.
Note that we do not accept Pull Requests via the Github mirror.
The Developer Mailing list is repo-discuss on Google Groups.
Gerrit is provided under the Apache License 2.0.
Install Bazel and run the following:
git clone --recurse-submodules https://gerrit.googlesource.com/gerrit
cd gerrit && bazel build release
The instruction how to configure GerritForge/BinTray repositories is here
On Debian/Ubuntu run:
apt-get update & apt-get install gerrit=<version>-<release>
NOTE: release is a counter that starts with 1 and indicates the number of packages that have been released with the same version of the software.
On CentOS/RedHat run:
yum clean all && yum install gerrit-<version>[-<release>]
On Fedora run:
dnf clean all && dnf install gerrit-<version>[-<release>]
Docker images of Gerrit are available on DockerHub
To run a CentOS 8 based Gerrit image:
docker run -p 8080:8080 gerritcodereview/gerrit[:version]-centos8
To run a Ubuntu 20.04 based Gerrit image:
docker run -p 8080:8080 gerritcodereview/gerrit[:version]-ubuntu20
NOTE: release is optional. Last released package of the version is installed if the release number is omitted.