This site has been archived and you can no longer log in or post new messages. For up-to-date community resources please visit ezplatform.com

eZ Community » Forums » Discussions » Missing documentation
expandshrink

Wednesday 23 April 2014 5:46:37 pm - 5 replies

» Read full blog post

Introduction

Documentation is crucial to users, beginners and experimented ones. As the eZ Publish Platform 5 grows and changes very quickly, the documentation has stacked up a big debt: some important topics are not documented, other are incomplete, or too complex...

Monday 28 April 2014 8:16:51 am

Hi

Could you provide a poll with the above mentioned elements that the users could check or type (eg. numbers) the most important missing docs? That would be more helpful.

Regards

Monday 28 April 2014 2:01:09 pm

Quote from Karol Radziuk :

Hi

Could you provide a poll with the above mentioned elements that the users could check or type (eg. numbers) the most important missing docs? That would be more helpful.

Regards

Yes I could, and I did.

Thank you for the idea.

Tuesday 29 April 2014 3:14:41 pm

Some wishes, in random order, not about "missing docs", but about "better docs" blunk.gif Emoticon

- a full pdf-export of the whole docs set

- keep comments open for doc users. possibly w. comments rating/starring

- faceted search, being able to filter f.e. by eZ version

- a more complete "reference" section

- code snippets which are tested for correctness

- code snippets should always have links to a full version, even when they display just a few lines

Modified on Tuesday 29 April 2014 3:17:18 pm by Gaetano Giunta

Tuesday 29 April 2014 3:43:42 pm

One thing I'd like to see again is documentation that's useable offline - I have a (grep) searchable version of the documentation on my laptop which I could use on the train.  The html zip files used to have all the documentation - last time I checked it only had links to the online documentation.  That may be better for collecting metrics but for my specific use case it makes the zip file useless.

Saturday 05 July 2014 12:45:40 pm

Hi,

This was a promising initiave, but so far I did not see that much changes that will make ez5 docs a useful tool to build successful ez5 project (instead of a painful experience). It has rather some specific topics which are well documented, but it is lacking something to glue the whole topics and make them part of a same story.

Hope to see at least this "Best Practices" most requested document by the survey contributors.

Thanks,

Hakim

expandshrink

You must be logged in to post messages in this topic!

36 542 Users on board!

Forums menu

Proudly Developed with from