Forums / General / Documentation - What do we actually need?

Documentation - What do we actually need?

Author Message

Per-Espen Kindblad

Monday 09 January 2006 2:43:14 am

The point with this content management system (eZ publish) is that companies can save development- and administration costs. If you have eZ publish installed, you and your users can administrate the content of the site, you can manage users and access, sections and design, administrate url's, rss and pdf, + much more, but documentation is often needed.

To achive cost saving, we all need documentation so we can do these things on our own. Documentation costs often only about 20% of just ONE support hour.

With this post I want to know what you all are missing when it comes to eZ publish documentation and in what languages.

Per-Espen

Paul Forsyth

Monday 09 January 2006 3:30:43 am

Lots of tutorials!

When a tutorial is no longer relevant due to technical changes it should be updated.

Paul

Xavier Dutoit

Monday 09 January 2006 9:50:10 am

Agree with Paul on the tutorials.

Also, you've got a lot of contributions that are there because there is, or was, something missing in ez.
You've got a lot of gems in the contrib, but that should be better linked with the rest of the documentation. I've found a lot of great examples in the contribs and I used them as documentation (how to create an attribute, an event...).

It would have been great to see on the doc, some hints saying that this feature is expended by that attribute. It would be useful to have a links on "how to create a workflow event" to some contributed events.

Also, it would be great to have an end-user documentation, as things like classes and attributes don't speak to them at all. I always have the same questions about when to use a folder and when to use an article, what does mean "the tag underline isn't allowed to be a child of strong" (or some kind of rather technical error messages).

X+

http://www.sydesy.com

eZ debug

Timing: Jan 18 2025 22:20:26
Script start
Timing: Jan 18 2025 22:20:26
Module start 'content'
Timing: Jan 18 2025 22:20:26
Module end 'content'
Timing: Jan 18 2025 22:20:26
Script end

Main resources:

Total runtime0.6905 sec
Peak memory usage4,096.0000 KB
Database Queries196

Timing points:

CheckpointStart (sec)Duration (sec)Memory at start (KB)Memory used (KB)
Script start 0.00000.0070 588.8594180.8359
Module start 'content' 0.00700.5688 769.6953575.4375
Module end 'content' 0.57580.1146 1,345.1328332.7656
Script end 0.6904  1,677.8984 

Time accumulators:

 Accumulator Duration (sec) Duration (%) Count Average (sec)
Ini load
Load cache0.00400.5783210.0002
Check MTime0.00150.2192210.0001
Mysql Total
Database connection0.00110.157910.0011
Mysqli_queries0.621189.94171960.0032
Looping result0.00190.27531940.0000
Template Total0.666496.520.3332
Template load0.00250.357320.0012
Template processing0.663996.145520.3320
Template load and register function0.00010.018510.0001
states
state_id_array0.00080.121210.0008
state_identifier_array0.00070.094320.0003
Override
Cache load0.00200.2949200.0001
Sytem overhead
Fetch class attribute can translate value0.00150.220040.0004
Fetch class attribute name0.00170.239750.0003
XML
Image XML parsing0.00130.191040.0003
class_abstraction
Instantiating content class attribute0.00000.001550.0000
General
dbfile0.00370.5302300.0001
String conversion0.00000.001030.0000
Note: percentages do not add up to 100% because some accumulators overlap

CSS/JS files loaded with "ezjscPacker" during request:

CacheTypePacklevelSourceFiles
CSS0extension/community/design/community/stylesheets/ext/jquery.autocomplete.css
extension/community_design/design/suncana/stylesheets/scrollbars.css
extension/community_design/design/suncana/stylesheets/tabs.css
extension/community_design/design/suncana/stylesheets/roadmap.css
extension/community_design/design/suncana/stylesheets/content.css
extension/community_design/design/suncana/stylesheets/star-rating.css
extension/community_design/design/suncana/stylesheets/syntax_and_custom_tags.css
extension/community_design/design/suncana/stylesheets/buttons.css
extension/community_design/design/suncana/stylesheets/tweetbox.css
extension/community_design/design/suncana/stylesheets/jquery.fancybox-1.3.4.css
extension/bcsmoothgallery/design/standard/stylesheets/magnific-popup.css
extension/sevenx/design/simple/stylesheets/star_rating.css
extension/sevenx/design/simple/stylesheets/libs/fontawesome/css/all.min.css
extension/sevenx/design/simple/stylesheets/main.v02.css
extension/sevenx/design/simple/stylesheets/main.v02.res.css
JS0extension/ezjscore/design/standard/lib/yui/3.17.2/build/yui/yui-min.js
extension/ezjscore/design/standard/javascript/jquery-3.7.0.min.js
extension/community_design/design/suncana/javascript/jquery.ui.core.min.js
extension/community_design/design/suncana/javascript/jquery.ui.widget.min.js
extension/community_design/design/suncana/javascript/jquery.easing.1.3.js
extension/community_design/design/suncana/javascript/jquery.ui.tabs.js
extension/community_design/design/suncana/javascript/jquery.hoverIntent.min.js
extension/community_design/design/suncana/javascript/jquery.popmenu.js
extension/community_design/design/suncana/javascript/jScrollPane.js
extension/community_design/design/suncana/javascript/jquery.mousewheel.js
extension/community_design/design/suncana/javascript/jquery.cycle.all.js
extension/sevenx/design/simple/javascript/jquery.scrollTo.js
extension/community_design/design/suncana/javascript/jquery.cookie.js
extension/community_design/design/suncana/javascript/ezstarrating_jquery.js
extension/community_design/design/suncana/javascript/jquery.initboxes.js
extension/community_design/design/suncana/javascript/app.js
extension/community_design/design/suncana/javascript/twitterwidget.js
extension/community_design/design/suncana/javascript/community.js
extension/community_design/design/suncana/javascript/roadmap.js
extension/community_design/design/suncana/javascript/ez.js
extension/community_design/design/suncana/javascript/ezshareevents.js
extension/sevenx/design/simple/javascript/main.js

Templates used to render the page:

UsageRequested templateTemplateTemplate loadedEditOverride
1node/view/full.tplfull/forum_topic.tplextension/sevenx/design/simple/override/templates/full/forum_topic.tplEdit templateOverride template
2content/datatype/view/ezimage.tpl<No override>extension/sevenx/design/simple/templates/content/datatype/view/ezimage.tplEdit templateOverride template
3content/datatype/view/ezxmltext.tpl<No override>extension/community_design/design/suncana/templates/content/datatype/view/ezxmltext.tplEdit templateOverride template
4content/datatype/view/ezxmltags/paragraph.tpl<No override>extension/ezwebin/design/ezwebin/templates/content/datatype/view/ezxmltags/paragraph.tplEdit templateOverride template
1content/datatype/view/ezxmltags/line.tpl<No override>design/standard/templates/content/datatype/view/ezxmltags/line.tplEdit templateOverride template
1pagelayout.tpl<No override>extension/sevenx/design/simple/templates/pagelayout.tplEdit templateOverride template
 Number of times templates used: 12
 Number of unique templates used: 6

Time used to render debug report: 0.0001 secs