Add a more in-depth readme with install instructions

Review Request #9807 — Created March 19, 2018 and submitted

Information

gerrit-reviewboard-plugin
master
d9d7a44...

Reviewers

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.

chipx86chipx86

This should have the www. prefix, to save a redirect.

chipx86chipx86

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

chipx86chipx86

No _ after releases.

chipx86chipx86

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

chipx86chipx86

No backticks needed if it's a single word.

chipx86chipx86

This sentence seem wrong. Might be missing a word?

chipx86chipx86

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 …

chipx86chipx86

No backticks needed for Gerrit.

chipx86chipx86

Double backticks are required for literals in ReST.

chipx86chipx86

This is actually going to fail on GitHub, sadly. Instead, you can just get rid of the .. code-block: and …

chipx86chipx86
chipx86
  1. 
      
  2. README.rst (Diff revision 1)
     
     
     
    Show all issues

    File headers should have the === on both sides.

  3. README.rst (Diff revision 1)
     
     
    Show all issues

    This should have the www. prefix, to save a redirect.

  4. README.rst (Diff revision 1)
     
     
     
    Show all issues

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

  5. README.rst (Diff revision 1)
     
     
    Show all issues

    No _ after releases.

  6. README.rst (Diff revision 1)
     
     
    Show all issues

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

  7. README.rst (Diff revision 1)
     
     
    Show all issues

    No backticks needed if it's a single word.

  8. README.rst (Diff revision 1)
     
     
     
    Show all issues

    This sentence seem wrong. Might be missing a word?

  9. README.rst (Diff revision 1)
     
     
    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://.....
    
  10. 
      
brennie
chipx86
  1. 
      
  2. README.rst (Diff revision 2)
     
     
    Show all issues

    No backticks needed for Gerrit.

  3. README.rst (Diff revision 2)
     
     
    Show all issues

    Double backticks are required for literals in ReST.

  4. README.rst (Diff revision 2)
     
     
     
     
     
     
    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.

  5. 
      
brennie
chipx86
  1. Ship It!
  2. 
      
brennie
Review request changed
Status:
Completed