Summary

Add a more in-depth readme with install instructions

Review Request #9807 — Created March 19, 2018 and submitted March 19, 2018, 9:45 p.m.

Information

Owner

brennie

Repository

gerrit-reviewboard-plugin

Branch

master

Bugs

Depends On

Commit

d9d7a44...

Reviewers

Groups

gerrit-reviewboard-plugin

People

Description

We now provide links to the builds, as well as the RB docs for
configuring Gerrit.

Testing Done

Issues

Description	From	Last Updated
File headers should have the === on both sides.	chipx86	March 19, 2018, 5:04 p.m.
This should have the www. prefix, to save a redirect.	chipx86	March 19, 2018, 5:04 p.m.
This header and the next should use === instead of ---, since it's a H1 level.	chipx86	March 19, 2018, 5:04 p.m.
No _ after releases.	chipx86	March 19, 2018, 5:05 p.m.
"Download into" sounds a bit odd. Maybe "Download the .jar file and place it in your gerrit/plugins directory ..."	chipx86	March 19, 2018, 5:05 p.m.
No backticks needed if it's a single word.	chipx86	March 19, 2018, 5:05 p.m.
This sentence seem wrong. Might be missing a word?	chipx86	March 19, 2018, 5:06 p.m.
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	March 19, 2018, 5:06 p.m.
No backticks needed for Gerrit.	chipx86	March 19, 2018, 8:16 p.m.
Double backticks are required for literals in ReST.	chipx86	March 19, 2018, 8:16 p.m.
This is actually going to fail on GitHub, sadly. Instead, you can just get rid of the .. code-block: and …	chipx86	March 19, 2018, 8:16 p.m.

flake8 passed.

JSHint passed.

README.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
File headers should have the === on both sides.
```
README.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
This should have the www. prefix, to save a redirect.
```

README.rst (Diff revision 1)

The issue has been resolved. Show all issues

This header and the next should use === instead of ---, since it's a H1 level.

README.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
No _ after releases.
```

README.rst (Diff revision 1)

The issue has been resolved. Show all issues

"Download into" sounds a bit odd. Maybe "Download the .jar file and place it in your gerrit/plugins directory ..."

README.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
No backticks needed if it's a single word.
```
README.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
This sentence seem wrong. Might be missing a word?
```

README.rst (Diff revision 1)

The issue has been resolved. Show all issues

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 URL on the next line, like:

.. _instructions:
   https://.....

Commit:

e542eba8e9731db8ed89d17b8d15ce8a9d88b51f

4ea6e407ef72b87b71aa218ce701c9430d4e82ff

Diff:

Revision 2 (+39 -19)

Show changes

	README.md
	README.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

README.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
No backticks needed for Gerrit.
```
README.rst (Diff revision 2)
The issue has been resolved. Show all issues
```
Double backticks are required for literals in ReST.
```

README.rst (Diff revision 2)

The issue has been resolved. Show all issues

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:

4ea6e407ef72b87b71aa218ce701c9430d4e82ff

d9d7a44827e40ad7dcc6bbf5d74207020acd037f

Diff:

Revision 3 (+37 -19)

Show changes

	README.md
	README.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed