Add 3 Doc Teams? about bisq-docs HOT 5 CLOSED

Something like this could make sense once we have a number of people actively contributing to docs. For now, it's enough to just have @bisq-network/docs-maintainers + people doing individual pull requests (like yourself @Francewhoa). But the thinking is good. Let's grow the contributor base to the point where we need this, eh?

from bisq-docs.

Note that I realized that I hadn't actually created @bisq-network/docs-maintainers prior to this issue, which I had meant to do. I've added that now.

from bisq-docs.

@cbeams :) Thanks for your reply. I noticed that you used the plural with the Github team name @bisq-network/docs-maintainers Good idea. Hopefully there are more than one doc, LOL ;)

How many active contributors to the docs presently?

I'm asking because this proposal is based on my guess-timate that they are presently 3 to 6 active contributors to Bisq docs? Between 3-6 interested contributors, those 3 teams would be useful to some now. But if there is presently only 1-2 active contributors, I agree it's too early to start the Github teams party, LOL ;) Maybe I missed the target on my guess-timate?

To clarify this proposal, today I reformatted it using the User Story and Assumptions format. Which are quoted below.

As you know this is a proposal, suggestion to adapt it are always welcome :) If you're not interested feel really free to decline :)

User Story

As contributors to Bisq documentation (docs) we need 3 Github teams so that:

• the on-boarding of newcomers docs contributors is facilitated
• communications, and notifications/mentions are easier and faster
• the risk of some contributors being left out of the communication loops is reduced
• the noise in the communications is reduce
• the newcomers contributors have a pleasant initial experience. Which in turn increase the retention. Which in turn increase the amount of docs contributors.

Assumptions

• Assumes this proposal is only for docs contributors interested in both using Github and using Github teams. Because some contributors may not be interested in those tools. In other words, the intention of this proposal is not about interfering with other volunteer contributors, or forcing tools or workflows on them. To each their own how, when, where they contribute. The only intent of this proposal is stated in the User Story above.
• Assumes those proposed team names
  1. docs-admins
  1. docs-maintainers
  1. docs-contributors
• Assumes those proposed usage
  1. doc-admins
  Member(s) of this team are interested in administrative tasks related to Bisq documentation. For example member(s) would have access to add or remove members to the doc-admins, doc-maintainers, doc-contributors teams, and doc repo(s).
  1. doc-maintainers
  Member(s) of this team are interested in tasks such as reviewing for approval Bisq doc contributions. For example review for approval the pull requests related to the doc repo(s). I'm assuming that for now only @cbeams needs this? In the future, and when needed members of the docs-admins team could add additional members? Depending on their present admin(s) workload.
  1. doc-contributors
  Member(s) of this team are interested in tasks such as contributing to Bisq docs. For example maintaining the already existing docs. So that they remain fresh and useful. For example if the Bisq software has a new feature or a existing workflow as changed, then update it accordingly. Or contributing new docs.
• Assumes the 3 Github teams would be useful for notification, for example @doc-contributors could be use to notify volunteers asking for their availability & interest to update or create a doc text, screenshots, links, video, etc.
• Assumes the new Github teams are nested under this "contributors" team
• Assumes the new Github teams permissions are visible

from bisq-docs.

@Francewhoa, the only people working on docs at the moment are you and me :)

This is why I'm saying that, while I generally like the thinking above, doing more stuff with teams can wait until there are actually teams of people doing stuff :)

Thanks though, much appreciated.

from bisq-docs.

@cbeams :) Well two people is twice as much as none. And better than nothing, LOL ;)

from bisq-docs.