Add a basic user manual for rb-gateway.
Review Request #10049 — Created June 29, 2018 and submitted
This change adds a user manual for rb-gateway. It includes (very very
simple) installation instructions, and documentation on how to configure
and run the service.
Built HTML and viewed results.
Description | From | Last Updated |
---|---|---|
E501 line too long (87 > 79 characters) |
reviewbot | |
E501 line too long (108 > 79 characters) |
reviewbot | |
E501 line too long (104 > 79 characters) |
reviewbot | |
E501 line too long (104 > 79 characters) |
reviewbot | |
E501 line too long (83 > 79 characters) |
reviewbot | |
E303 too many blank lines (4) |
reviewbot | |
Can you add an anchor to this? Maybe rbgateway-index? That'll help with linking from the Review Board manual. |
chipx86 | |
The "... which can require additional APIs" feels a little redundant. Maybe just get rid of that bit. |
chipx86 | |
Can you add a rbgateway-configuration anchor? |
chipx86 | |
Rather than ::, this would be better with: .. code-block:: javascript <code here> That'll ensure syntax highlighting is correct. |
chipx86 | |
Missing webhookStorePath. |
brennie | |
Definitions should be indented 4 spaces (here and below). |
chipx86 | |
Do we have a default? |
chipx86 | |
Misisng webhookStorePath |
brennie | |
Above, we don't use colons after the name/type, but we do here. We should be consistent. |
chipx86 | |
Might want to mention this is also included as /contrib/rb-gateway.service |
brennie | |
This can, I think, be: .. code-block:: ini <code...> |
chipx86 | |
How about a simple /usr/local/bin/rb-gateway and /etc/rb-gateway/? I know some things like /opt/rb-gateway/, but I feel like that's less standard … |
chipx86 | |
Can you add: ExecReload=/bin/kill -HUP $MAINPID This allows users to do systemctl reload rb-gateway Also, do you mind adding this … |
brennie | |
Can you add an rbgateway-installation anchor here? |
chipx86 | |
I feel like we should provide more guidance here, and we should link to the download page (it'll be https://www.reviewboard.org/downloads/rbgateway/). … |
chipx86 | |
It also will need write access to the token store path and the webhook store path |
brennie | |
E501 line too long (87 > 79 characters) |
reviewbot | |
E501 line too long (94 > 79 characters) |
reviewbot | |
E501 line too long (90 > 79 characters) |
reviewbot | |
E501 line too long (90 > 79 characters) |
reviewbot | |
E501 line too long (83 > 79 characters) |
reviewbot | |
E303 too many blank lines (4) |
reviewbot | |
I'm guessing we'd want /etc/rb-gateway/rb-gateway.conf, since there's also a webhooks.conf, right? |
chipx86 | |
I realized the flaw with my idea here is that we have a version per platform. So maybe latest/linux_amd64/, which … |
chipx86 | |
E501 line too long (87 > 79 characters) |
reviewbot | |
E501 line too long (94 > 79 characters) |
reviewbot | |
E501 line too long (90 > 79 characters) |
reviewbot | |
E501 line too long (90 > 79 characters) |
reviewbot | |
E501 line too long (83 > 79 characters) |
reviewbot | |
E303 too many blank lines (4) |
reviewbot |
-
-
Can you add an anchor to this? Maybe
rbgateway-index
? That'll help with linking from the Review Board manual. -
The "... which can require additional APIs" feels a little redundant. Maybe just get rid of that bit.
-
-
Rather than
::
, this would be better with:.. code-block:: javascript <code here>
That'll ensure syntax highlighting is correct.
-
-
-
-
-
How about a simple
/usr/local/bin/rb-gateway
and/etc/rb-gateway/
? I know some things like/opt/rb-gateway/
, but I feel like that's less standard and more prone to confusing people. -
-
I feel like we should provide more guidance here, and we should link to the download page (it'll be https://www.reviewboard.org/downloads/rbgateway/).
I also think we can do something useful with providing a handy redirect on the site that points to the latest download (say, https://www.reviewboard.org/downloads/rbgateway/latest/), since the URL will be predictable and we know the version information on the server. With that, we can have something like:
You can `download the latest version`_ of ``rb-gateway`` or view the `downloads page`_ for other options. Once downloaded, place the binary somewhere on your server (for example, on Linux, :file:`/usr/local/bin/rb-gateway`) and make it executable. You'll also need a place to store the configuration files (for example, :file:`/etc/rb-gateway/`). For example, to get started quickly on Linux: $ sudo curl https://www.reviewboard.org/downloads/rbgateway/latest/ \ -O /usr/local/bin/rb-gateway $ sudo chmod +x /usr/local/bin/rb-gateway $ sudo mkdir /etc/rbgateway
Once installed, follow the :ref:`configuration instructions <rbgateway-configuration>` to finish setting up your server.
- Commit:
-
6f3e85f8e45dcaee49993d0341a3149325d0411f81d596861655731da229a5fe4b297ce33d6674a5