Documentation Week Requests

We’re trying to organize a documentation week effort across the Dec. 9th to 13th, where development and operations teams will be focusing on adding and improving FoundationDB’s documentation.

Part of this is trying to figure out all the pieces of documentation that need to be written or improved. These are currently tracked as label:documentation issues. Is there anything in that list that folk would like to see added that isn’t already there?

Most of the code examples in the documentation are in Python, which not everyone can read. I would like to see language tabs in code examples, something like

I’d love documentation on sizing a 3 & 5 node cluster on a typical cloud provider like AWS - i.e. what machine types / how many processes per machine / what class each process should have. Obviously, cluster setup probably varies a lot based on workload, but I would find a starting point valuable.

1 Like