No, you aren't the only one. I understand the Magnolia team is really
small and have a lot on their plate. Maybe a brief white paper or two
on some of the services and interfaces intended to be exposed to
developers would be a starting point. I've contributed to the wiki in
the past and would be happy to contribute docs in the future -- just
need a hint or two regarding the new code in areas that have been most
fundamentally changed. Such docs would also be a good starting point
for inviting others to contribute improvements like helping maintain the
taglibs.
--David
Will Scheidegger wrote:
Dear Magnolians
Am I the only one that is a bit worried about the state of Magnolia?
While the development work that we see is fabulous, the documentation
lags _far_ behind.
- Did you know, that a new tag library was introduced with Magnolia
3.5? I'm sure it does slick things, but we will never find out about
them unless we trip over them by accident.
- By know you probably have heard, that the access control to pages/
URLs has bin completely modified in 3.5 - but do you know how things
really work?
- When you visit documentation.magnolia.info it tells you that the
current release is 3.0, also the API linked there is the one from
3.0. The last update seems to be from May 25th.
- The new Wiki is a mess. It has no structure at all so it is nearly
impossible to browse through articles to find out what is documented
and what not. On top of that "hopefully we receive a license in the
next week" has been greeting us from the front page for a month now.
MY GOAL IS NOT BASHING THE MAGNOLIA TEAM. As I said: They are doing a
terrific job developing Magnolia. I just wanted to emphasize that not
investing in documentation will not help at all in the long run.
As I said before on- and off-list: I am more than happy to help
documenting things. But I would need the following before I get started:
- Specific task: What should I document, what is taken care of by
others?
- Contact: Who can I contact when I have questions?
- Place + access: Where should I document + how? Wiki,
documentation.magnolia.info, other?
The Magnolia developer have delivered the basis for blowing away
other CMS - if we don't deliver the missing documentation to it, the
world will not be able to honor the hard work of the developers!
Amen!
And now... back to work.
Cheers,
Will
----------------------------------------------------------------
for list details see
http://documentation.magnolia.info/docs/en/editor/stayupdated.html
----------------------------------------------------------------
----------------------------------------------------------------
for list details see
http://documentation.magnolia.info/docs/en/editor/stayupdated.html
----------------------------------------------------------------