Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Currently the process for becoming a besu-docs maintainer mirrors the process for becoming a besu maintainer, but based on besu-docs contributions rather than besu code contributions.

However this leads to two issuesthe issue

  • besu developers contribute to the docs but none have so far met the requirement for "5 significant contributions" in order to become a besu-docs maintainer
  • small number of besu-docs maintainers is a bottleneck prevents besu maintainers from directly contributing to the besu-docs repositoryfor getting PRs approved.

The besu-docs repo has CI steps to check formatting, grammar, validity of internal and external HTTP links. 

All changes to besu-docs also require separate approval. 

Proposal 

Essentially relax the first requirement of the process for ie "The proposed maintainer authors and has accepted five significant changes".

Since we trust besu maintainers to make changes to the code, this proposal is to also trust those individuals to make changes to the related docs. Individuals need to be aware of their areas of expertise. Just as we expect besu maintainers to use their judgment when reviewing besu PRs, we expect besu-docs maintainers to use their judgment when reviewing besu-docs PRs. If the change is significant, defer to someone with expertise in that area.

Proposal:

  • have all current besu ask for volunteers from current Besu maintainers become besu-docs maintainersexisting
  • current besu-docs maintainers remain besu-docs maintainersraise PR to add none/some/all of those volunteers (considering their contributions to besu-docs so far), and this PR requires approval as per the process 
  • the rest of the process is followed as-is
  • existing besu-docs maintainers remain besu-docs maintainerswhen someone becomes a besu maintainer, they also become a besu-docs maintainer
  • still keep the separate process for someone to become a besu-docs maintainer without first becoming a besu maintainer.