reStructuredText
For the eZ components we are currently writing introductionary tutorials for each component. These tutorials should be a first start in understanding the abilities of each specific component without having to go through the full API documentation.
As good programmers we hate to document and thus the easier we can make the process the better documentation we will get. For our internal documents we use plain text files in SVN, describing guidelines and conventions. Those text files are formatted using reStructuredText , a format used by the Python community. It is a very easy to remember syntax, wiki-like, and it is easy to convert to HTML. We also decided to used the same format for our tutorials because it is such an easy format. With a specific PHP script we generate HTML from the tutorials, and add links to the other documentation that is generated by phpDocumentor from our inline API documentation.
Comments
Did you also check markdown and what where your reasons to choose restructured text?
Basically because some of us were already familiar with it. For example I've been using it to document Xdebug's DBGp protocol (http://xdebug.org/docs-dbgp.php). I had also never heard of markdown before, but their syntax seems to be very similar to the one that reStructuredText uses.
Another important benefit of using reStructuredText is that the documentation file (source) without parsing is also very readable.
Life Line
Created a bench and a crossing
Created 2 benches and a crossing; Updated 5 cushions, a post_box, and a crossing
Created a crossing; Updated a cushion
If you were wondering whether the www.php.net & downloads.php.net services weren't responding very well in the last 6 hours — thousands of requests/sec to https://www.php.net/ 's root.
The server's load was 720, didn't die, but CDN connections to it timed out.
Now there is a caching strategy in place for a selected set of resources.
Updated a bench
Created 3 benches; Updated 10 benches
Updated a bench
Updated a bus_stop
Created a bench and a waste_basket; Updated 6 bus_stops and a crossing
Created 2 waste_baskets and a recycling; Updated 2 bicycle_parkings and a recycling
Updated a fast_food, a funeral_directors shop, and 2 other objects; Confirmed a fast_food and a hairdresser shop
Created an information; Updated 3 benches and 2 waste_baskets
Updated 2 benches and a waste_basket
Updated a bench
Created a waste_basket and an information
Created a waste_basket
I hiked 18.0km in 4h1m52s
I walked 1.4km in 17m19s
I walked 4.5km in 1h21m49s
I just made and ate, a bowl full of bacon fried Brussels Sprouts. Not under duress, and out of my own free will.
#winning #food #BrusselsSprouts
Added new residential building
Created a hairdresser shop; Confirmed a convenience shop and a dry_cleaning shop
Created a building_materials shop, a vacant shop, and 4 other objects; Confirmed a hairdresser shop, a cafe, and 2 other objects
I walked 8.3km in 1h33m44s
Shortlink
This article has a short URL available: https://drck.me/r-4nt