Re: Tutorial - request for feedback
| From: | Maciej Sobaczewski | Date: | Tue, 17 Jun 2014 17:13:16 +0000 |
| Subject: | Re: Tutorial - request for feedback | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969385004@lists.php.net to get a copy of this message | ||
Hello guys,
Work is moving forward, but I need your help with tutorial.
1) Style guidelines - I don't really know what should be placed there. As Hannes said, we currently have two resources:
https://wiki.php.net/doc/articles/nomenclature
https://wiki.php.net/doc/howto/styleguide
Second document refers to Fedora Docs Style Guide. I have work-in-progress version of this chapter ready on my computer, but it's mostly copy&paste from Fedora resource and some parts from FAQ and /howto/styleguide. However, it's definitely too long. Most people would probably just omit this section, so I don't know if it's good point to start from.
Here is the draft: https://gist.github.com/Sobak/31658e821b056587271c
Any advices or thoughts how to keep this part relatively short, simple and compatible with rules we are actually following?
2) Little quote from current draft:
"This tutorial assumes that you have basic knowledge about SVN. If not, you can read {TODO}."
I don't think we should write own resource here. Mainly because it is really big topic, probably much bigger than rest of this tutorial. What do you think? Anyone know good resource we can link here?
Thanks,
Maciej
PS: I allowed myself to CC people who probably know a lot about those topics.