[bisq-network/roles] Bitcoin Node Maintainer (#66)

Chris Beams notifications at github.com
Tue Jul 17 09:42:03 UTC 2018


@sqrrm, regarding keeping the description for this role (and the Tor Relay Operator role at #72) up to date, I mentioned above that I'd have instructions for all role owners on this soon, but what I'd actually like to do, if you're willing, is to have you try out the instructions first and provide feedback about it before I send out a broader request to have everyone do the same.

I'll provide a little context here, so that hopefully everything makes sense, but in the end, it should be a fairly simple task, one that will probably take 30 minutes or perhaps an hour for most roles.

First it's a good idea to read through the new Roles doc at https://docs.bisq.network/roles.html if you haven't already. It provides (hopefully) everything that contributors need to know about how roles work.

The relevant section of that doc that I want to focus on here is the Docs section at https://docs.bisq.network/roles.html#docs:
 
![image](https://user-images.githubusercontent.com/301810/42808327-5ed8723e-89b3-11e8-9b98-79fae6ba65b7.png)

To follow those instructions for this role, you'd put together a pull request against the bisq-docs repository that adds a `btcnode.adoc` file. That file would include:

 - an `Introduction` section that explains what the Bisq federation of Bitcoin Core nodes is for, how it helps protect user privacy, etc.
 - an `Infrastructure` section that mentions the `bisq-btcnode` repository and `btcnode` slack channel.
 - a `Roles` section that details the Duties, Rights, GH Issue and GH Team for both the btcnode Maintainer and Operator roles.
 - if appropriate, a `Processes` section that details any processes involved with btcnodes, e.g. upgrades.

The Proposals doc at https://docs.bisq.network/proposals.html provides an example for what such a doc should look like; please treat it as a template.

You'll also want to add an entry to `index.adoc` to make sure that your new `btcnode.adoc` doc is discoverable. For right now, you can just put it at the bottom of the list in the `Contributor Docs` section. I plan to revise the index page soon to better accommodate these kinds of docs.

One of the effects of having these docs is that the descriptions in role issues like this one become simple, uniform, and largely unchanging. There's little need to "keep them up to date", and that avoids permissions problems like the one you had where you were unable to edit this issue (because I was the one who created it). The description ends up being as simple as this:

```
Docs: https://docs.bisq.network/btcnode.adoc#maintainer
Team: @bisq-network/btcnode-maintainers
Primary owner: @sqrrm
```

So, please let me know if it works for you to do this, and I'll look out for your PR. Thanks!

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/roles/issues/66#issuecomment-405523448
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20180717/117e283e/attachment-0001.html>


More information about the bisq-github mailing list