Election documentation is insufficient/incorrect

[baumanj]

There are a number of problems with both the formal documentation and code comments currently:

• [ ] Suitability hook documentation should provide more detail, including that it only applies directly to topology leader elections
• [ ] Elections documentation and code comments incorrectly indicate that the elections algorithm is the Bully algorithm, when it is closer to the Invitation algorithm, but with significant differences
• [ ] Elections documentation incorrectly indicates that rings with an even number of supervisors should be avoided and that they can lead to unrecoverable split-brain scenarios
• [ ] Elections documentation only discuss GUID comparison and makes no mention of suitability calculations which take precedence
• [ ] Elections documentation don't discuss the update elections at all or how they differ and interact with topology elections
• [ ] Elections documentation don't discuss how applications can take advantage of the leader property in runtime configuration

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. We value your input and contribution. Please leave a comment if this issue still affects you.

[jsirex]

I'm seeing some documentation. Is it still actual? Or documentation isn't correct?

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. We value your input and contribution. Please leave a comment if this issue still affects you.