10 Tips for New eZ Publish Developers

1/365 [dazed & confused] (by PhotoJonny)We've all been there, starting out with a new product and not knowing where to begin. Below are my top 10 tips for new eZ publish developers.

  1. Read the install documents and make sure your system meets the requirements before beginning. eZ Publish has some hefty needs in terms of memory limits and timeouts that may not be set at recommended levels in some PHP setups. Not having these values set to acceptable levels will impact on a successful install.
  2. Don't modify the core distribution. Just don't, no matter how tempting it is. There is no need to modify any files that come as part of the eZ Publish distribution. This will save you losing any changes when you upgrade.
  3. Understand the basics. eZ Publish doesn't store content in straight database tables like other Content Management Systems. Read the documentation and understand the content model. eZ Publish is all about content objects arranged in a tree, not data stored in tables.
  4. Debugging holds the answers. If something is not working as expected turn on debugging and check the output. Most times the answer or a pointer to what is wrong will be found in the debug output. Check the Web Server error logs for issues as well. If this still doesn't help, clear the caches and try again.
  5. Use the Community. If you still have trouble, use the forums. There is a great developer community around eZ publish and they are usually happy to help.
  6. Provide enough information. Include as much information as possible in your forum post. Include a detailed explanation of what you are attempting to achieve, what is or isn't happening, code samples, specifics of your setup and debug information.
  7. Don't "force" it. If something seems overly difficult it usually means that you aren't approaching it in an optimal way. As with most things there are several ways to achieve the same outcome, some better than others. Ask the community for help (see above).
  8. Comment your code. Before you start to write any code (templates, PHP, settings) describe what you are going to achieve in a comment. This will not only help you focus on what is required but serve as documentation for anyone who has to work with your code in the future. Remember this may be you in 6 months time.
  9. Write readable code. Follow a coding standard. eZ have a number for various aspects of the system: Templates, PHP & SQL. There used to be a PDF eznetwork_development_guidelines.pdf up on the eZ site that contains all this info and more but it longer exists - eZ people can this go back? If you are interested email me/comment for a copy.
  10. Plan ahead. Document what you are going to do before starting. This doesn't have to be elaborate or time consuming but will save you time in the long run as well as providing a guide to how the site was put together. I've found that the absolute basics are a sitemap, and a list of content types, their views and how they are applied in the site.
What do you wish someone had told you when you first started using eZ Publish?

Comments

  1. Joe8:55 pm, October 09, 2008

    11. Clear the Cache

    If you made a change, but it doesn't seem to have had any effect, you may need to clear the cache. Also, adjust settings during development so the caches are disabled (ViewCaching, PreviewCache, StaticCache, TemplateCache).

    ReplyDelete
  2. Anonymous10:26 pm, October 09, 2008

    Hi Bruce

    Apparently the eZ Network development guidelines are not available to everyone any more, but only to eZ partners.

    ReplyDelete
  3. Unknown11:06 pm, October 09, 2008

    Hey Joe,

    Thanks for the input. Cache clearing was mentioned in number 4, I mean how could I leave that one out! Perhaps it does need it's own item?

    Cheers
    Bruce

    ReplyDelete
  4. Unknown11:12 pm, October 09, 2008

    Hey Kristof

    Seems a strange document to restrict access to.

    I would have thought that having that information available to everyone would benefit the entire community.

    Cheers
    Bruce

    ReplyDelete
  5. Unknown10:51 pm, April 16, 2009

    Hi, I'm a french beginner with eZ Publish and i'm intressting by your PDF : eznetwork_development_guidelines.pdf

    If you have good link to learn how to use template... because I for me it's very difficult.

    Thank you,
    Florian.

    ReplyDelete

Post a Comment

Popular posts from this blog

eZ Publish Admin Prototype extension

Following on from yesterdays post on checking out the eZ Admin Interface prototype I've created an extension that can be easily downloaded, installed and enabled. Download the extension from here Copy to your extension directory and untar: tar xzf admin2prototype.tgz Enable it in your admin siteaccess by editing settings/siteaccess/site_admin/site.ini.append.php and adding: [ExtensionSettings] ActiveAccessExtensions[]=admin2prototype Clear the cache To disable, simply remove the settings from step 3 above and clear the cache. Note: If you enable the extension via the admin interface (Setup -> Extensions) this will effect all site accesses including your front end ones.  Things to check out in the prototype: Lack of Shop and Design tabs - these are disabled by default in eZ Publish 4.3 Hidden right menu. Click on the [+] to expand Content menu (Left Hand side under Content, Users & Media Tabs) can be variably sized. Grab the bottom right hand corner an...
Read more

eZ Publish 5 Virtual Machine

One of the most common issues of newcomers to eZ Publish is the setup of a system suitable for running it. Without a correctly configured system in place they usually do not get beyond the installation process and abandon their evaluation before having experienced the product.  The eZ Publish puppet module is an attempt to codify the requirements  for running eZ Publish and provide a means for automatically creating a system suitable for running it - no more following a checklist of "setting up eZ Publish on XYZ". The eZ Publish 5 Virtual Machine can be found on github at  https://github.com/brucem/vagrant-puppet-ezpublish .   It combines Vagrant, VirtualBox & Puppet to generate a VM with the current eZ Publish community version (2013.4) installed and ready to be configured. The README.md  provides details of the requirements and how to use it. Vagrant is a system that  orchestrates the automatic creation and configuration of s...
Read more

eZ Publish Admin redesign - Dashboard = OpenSocial?

Image
In the preface to the current Admin interface specification the last paragraph caught my eye: A overview of user task need a dashboard , where she can follow here own content, approval and other tasks she might do on a regular basis. I recently saw a demo of the latest version of the bug tracking system JIRA 4.0 by Atlassian . It used an OpenSocial dashboard to allow users to customise their homepage to access and interact with information that was important to them.  The system not only displays JIRA widgets but any OpenSocial widgets (and those from other Atlassian products ). You can check out a video of it in action here and more information on how Atlassian is using OpenSocial here . What is OpenSocial? From the official site: OpenSocial defines a common API for social applications across multiple websites. With standard JavaScript and HTML, developers can create apps that access a social network's friends and update feeds. Google personal home page is an example o...
Read more