Documenting Cloud (and other) services
| From: | Philip Olson | Date: | Thu, 09 Jun 2011 01:53:16 +0000 |
| Subject: | Documenting Cloud (and other) services | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969382759@lists.php.net to get a copy of this message | ||
Hello Everyone,
We recently received a request to document PHP + Azure. This is not something we've done
before, so let's discuss where this might go and how it may look (and apply/plan this to
similar services like EC2) in the future. We don't want to get into a situation where
we'll need to move sections around later (broken links/translations/ids) so a little planning
now will help. And keeping them all together feels wise.
We must also determine if we want to do this. I wasn't sure but Rasmus made several convincing
arguments. Users will benefit by sharing user-contributed notes. And users want to know that PHP
works "in the cloud" (and how) so let's tell them about it. And the documentation
should be brief, have plenty of examples, and link elsewhere for further information.
This is a slippery slope but at this point we could draw the line in the cloud^Wsand with cloud
computing. A section can talk a little about cloud computing and then show where PHP fits in. This
is where people will go after hearing about how great clouds are.
The appendix is the simplest place to store this but maybe we can come up with a better location
because the appendix has outgrown itself. The install section comes to mind, where we'd create
a new section next to OS. Windows Azure, for example, would be listed under "Cloud
Computing" and not with install/windows in this scenario. However, 'install' limits
the scope of the conversation because we'll probably want to expand the entire topic.
What do people think about this?
Regards,
Philip