eZ Community » Blogs » Core Development team » Missing documentation

By

Missing documentation

Wednesday 23 April 2014 5:46:33 pm

  • Currently 5 out of 5 Stars.
  • 1
  • 2
  • 3
  • 4
  • 5

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...

Together with the Engineering Team, we did a first brainstorming to gather an initial list of those elements, that you can find below. We will focus on paying this debt in the next weeks, but we have most likely missed quite a few topics. As a real life user of the product, you have most likely stumbled upon those. Which ones? What would you change/add/remove from this list?

eZ Publish Documentation

Picture credit : nathan williams from London, UK (Cinema Book Shop) [CC-BY-2.0]

1/ What is missing in the documentation right now?

You will find the list of missing topics in our JIRA issue tracker, at time of writing the main once were:

 

2/ How can I help?

  • by asking questions ;-)
  • by pointing out another topics missing and create a new JIRA issue and label it “missing-doc”.
  • by contributing documentation: the simplest way to help is to pick a JIRA Issue from the list, and add a comment, or attach a markdown file, or...

In any case, we will focus on the identified topics, by priority, very soon (may), most likely for one sprint. Feedback will be taken into account as much as possible, and will try to use whatever you can provide us with to make this even better.

So, what do you think? What is the ONE thing you’d like to see in the documentation? Let us know ;-)

Proudly Developed with from