imfreedom/contributors-guide

Update the reviewboard login stuff to reflect the current state of things.

16 months ago, Gary Kramlich
6e49362c1576
Parents 263362a32cd3
Children 97dd676b0777
Update the reviewboard login stuff to reflect the current state of things.

Testing Done:
Ran codespell and viewed it in a browser.

Reviewed at https://reviews.imfreedom.org/r/2119/
2 files changed, 29 insertions(+), 8 deletions(-)
  • +26 -8
    docs/code_contributions.md
  • +3 -0
    mkdocs.yml
    • --- a/docs/code_contributions.md Mon Dec 12 01:10:52 2022 -0600
    +++ b/docs/code_contributions.md Mon Dec 12 02:42:16 2022 -0600
    @@ -94,20 +94,38 @@
    To be able to submit a review request you need to have an account on our
    JetBrains Hub instance at [hub.imfreedom.org](https://hub.imfreedom.org). You
    can create an account here in a number of ways and even turn on two factor
    -authentication. But please note that if you turn on two factor authentication
    -you will need to create an [application
    -password](https://www.jetbrains.com/help/hub/application-passwords.html) to be
    -able to login to Review Board.
    +authentication.
    +
    +When logging in to review board, please make sure to use the
    +"login with hub.imfreedom.org" button. Doing so will avoid having to use an
    +application password if you have two factor authentication turned on.
    Once you have that account you can use it to login our Review Board instance at
    [reviews.imfreedom.org](https://reviews.imfreedom.org). Please note, you will
    have to login via the web interface before being able to use RBTools.
    Once you have an account and have logged into our Review Board site, you can
    -begin using RBTools. In your shell, navigate to a Mercurial clone of one of the
    -Instant Messaging Freedom related projects, then run the `rbt login` command.
    -You should only need to do this once, unless you change your password or have
    -run the `rbt logout` command.
    +begin using RBTools. To get started, you'll need to grab an API token from
    +reviewboard from [here](https://reviews.imfreedom.org/account/preferences/#authentication), or you can go to `<username>` -> `My Account` ->
    +`Authentication` manually. Copy that API token to your clipboard.
    +
    +Now in your shell, navigate to a Mercurial clone of one of the Instant
    +Messaging Freedom related projects, then run the following command:
    +
    +```
    +rbt login --api-token <the api token on your clipboard>
    +```
    +
    +!!! tip
    +
    + This command may be automatically saved to your shell history. If you're on
    + a UNIX like system, you can use the `history` command to remove it from
    + your history. You can find more information about doing so
    + [here](https://www.linuxshelltips.com/remove-command-from-history-in-linux/).
    +
    +Note: this may say "you're already logged in", this is a bug in RBTools and
    +will be fixed in a future version. You should only need to do this once, unless
    +you change your password or have run the `rbt logout` command.
    ## Creating a New Review Request
    --- a/mkdocs.yml Mon Dec 12 01:10:52 2022 -0600
    +++ b/mkdocs.yml Mon Dec 12 02:42:16 2022 -0600
    @@ -7,3 +7,6 @@
    - Using Mercurial: mercurial.md
    - Contributing Code: code_contributions.md
    - Repository Hosting: repository-hosting.md
    +markdown_extensions:
    + - admonition
    +