Add a more in-depth readme with install instructions
Review Request #9807 — Created March 19, 2018 and submitted
We now provide links to the builds, as well as the RB docs for
configuring Gerrit.
Description | From | Last Updated |
---|---|---|
File headers should have the === on both sides. |
chipx86 | |
This should have the www. prefix, to save a redirect. |
chipx86 | |
This header and the next should use === instead of ---, since it's a H1 level. |
chipx86 | |
No _ after releases. |
chipx86 | |
"Download into" sounds a bit odd. Maybe "Download the .jar file and place it in your gerrit/plugins directory ..." |
chipx86 | |
No backticks needed if it's a single word. |
chipx86 | |
This sentence seem wrong. Might be missing a word? |
chipx86 | |
Should use docs/manual/latest/ instead of docs/manual/3.0/, so it's future-proof. Also, since this exceeds the line length, you can start the … |
chipx86 | |
No backticks needed for Gerrit. |
chipx86 | |
Double backticks are required for literals in ReST. |
chipx86 | |
This is actually going to fail on GitHub, sadly. Instead, you can just get rid of the .. code-block: and … |
chipx86 |
-
-
-
-
README.rst (Diff revision 1) This header and the next should use
===
instead of---
, since it's a H1 level. -
-
README.rst (Diff revision 1) "Download into" sounds a bit odd. Maybe "Download the
.jar
file and place it in yourgerrit/plugins
directory ..." -
-
-
README.rst (Diff revision 1) Should use
docs/manual/latest/
instead ofdocs/manual/3.0/
, so it's future-proof.Also, since this exceeds the line length, you can start the URL on the next line, like:
.. _instructions: https://.....
Commit: |
|
||||
---|---|---|---|---|---|
Diff: |
Revision 2 (+39 -19) |
Checks run (2 succeeded)
-
-
-
-
README.rst (Diff revision 2) This is actually going to fail on GitHub, sadly. Instead, you can just get rid of the
.. code-block:
and use two colons after "run", and it'll do a standard pre block.
Commit: |
|
||||
---|---|---|---|---|---|
Diff: |
Revision 3 (+37 -19) |