Add a more in-depth readme with install instructions

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

brennie
gerrit-reviewboard-plugin
master
d9d7a44...
gerrit-reviewboard-plugin

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



  • 0
  • 0
  • 11
  • 0
  • 11
Description From Last Updated
chipx86
  1. 
      
  2. README.rst (Diff revision 1)
     
     
     

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

  3. README.rst (Diff revision 1)
     
     

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

  4. README.rst (Diff revision 1)
     
     
     

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

  5. README.rst (Diff revision 1)
     
     

    No _ after releases.

  6. README.rst (Diff revision 1)
     
     

    "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)
     
     

    No backticks needed if it's a single word.

  8. README.rst (Diff revision 1)
     
     
     

    This sentence seem wrong. Might be missing a word?

  9. README.rst (Diff revision 1)
     
     

    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)
     
     

    No backticks needed for Gerrit.

  3. README.rst (Diff revision 2)
     
     

    Double backticks are required for literals in ReST.

  4. 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.

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

Status: Closed (submitted)

Loading...