![[staff profile]](https://www.dreamwidth.org/img/silk/identity/user_staff.png){kind=small}
![[site community profile]](https://www.dreamwidth.org/img/comm_staff.png){kind=small}
Entry tags:
call for doc requests
Hey --
I realize that there's a lot of things that would be useful to disseminate. Stuff about the way the code works, some conventions, why things are the way they are, and more advanced topics like database handles and stuff like that. I'd love to get some requests -- see what people are really the most curious about, so I can prioritize writing the docs. But here are some things I've thought of:
* What is a database master, slave, when should I call "get_db_writer" versus "get_db_reader" and what is this "get_cluster_def_reader" thing anyway?
* What are database clusters, what is the global database, what goes where?
* What is TheSchwartz/Gearman, how do I use it, when should I?
* What should be stored in memcache, what are the best practices?
* ...
Crap, I had a bunch more when I was thinking about this before bed last night. Should have written them down then... oh well. Is there anything you are curious about that you think might make a good bit of documentation?
I realize that there's a lot of things that would be useful to disseminate. Stuff about the way the code works, some conventions, why things are the way they are, and more advanced topics like database handles and stuff like that. I'd love to get some requests -- see what people are really the most curious about, so I can prioritize writing the docs. But here are some things I've thought of:
* What is a database master, slave, when should I call "get_db_writer" versus "get_db_reader" and what is this "get_cluster_def_reader" thing anyway?
* What are database clusters, what is the global database, what goes where?
* What is TheSchwartz/Gearman, how do I use it, when should I?
* What should be stored in memcache, what are the best practices?
* ...
Crap, I had a bunch more when I was thinking about this before bed last night. Should have written them down then... oh well. Is there anything you are curious about that you think might make a good bit of documentation?
no subject
I'd really like to see some of the standard libraries documented. Simple things like Storable and LJ::eurl() and such that a lot of people are likely to want to use, but might not know about if the bit of code they're editing doesn't use them already.
Some other potential topics:
JavaScript and the AJAX system
An overview of the Entry/Comment data model and API
The Event/Notification system