New Forum Idea: Tips & Tricks ?

Author Message

Alex Jones

Friday 11 July 2003 8:30:50 am

As I've been asking questions and ramping up on the code I realized that I'm learning a lot of small things which aren't always in the documentation, or perhaps wouldn't fit in the documentation and I was thinking that it might be good to have a forum for people to post tips and tricks. My only concern is that this might take away from the documentation, which is far too important to lose visibility.

That being said, I think some jewels of knowledge might slip away either undocumented, or buried in a comment within the documentation. When using other software I've come up with great ideas for my site merely by reading someone else's tip. Often times discovering functionality that I wasn't aware of, even though I had read the docs.

I like the idea of a forum as most people who are using eZ publish will visit often and see the section as it's updated; whereas many of us have printed out the documentation and would not know of newer tips unless we decided to go to that section of the documentation.

This is a great package and I want to ensure we all get the most use out of it as possible.

Alex

Alex
[ bald_technologist on the IRC channel (irc.freenode.net): #eZpublish ]

<i>When in doubt, clear the cache.</i>

Karsten Jennissen

Friday 11 July 2003 8:39:20 am

Hi Alex,

I can understand that people will go to the forum more often than to look for changes in the docs. Afaik, there is some view in the works that displays the changes to the docs in a more detailed and longer history so you would just check that every so often.

The documentation is meant to be Wiki style, so actually, if you discover something or you get an answer in the forum, it would be really cool if you could take a minute and add it to the appropriate place in the docs (or maybe just edit one of the pages already there).

Karsten

Paul Forsyth

Friday 11 July 2003 8:46:28 am

One of the nice features of the new documentation area is the commenting that is now allowed. Im a fan of the www.php.net style of comments on manual pages that allow people to enter their ideas, problems, examples of the relevant section. I hope that will be repeated here and tips and tricks slowly appear with the appropriate documentation.

It has good to see that those posters who have been using the forum for a while now tend to link to a good post or good piece of documentation explaining something a person is looking for. In time this will likely expand to linking to the tips and tricks in the documentation. Consquently there will be good search results for a problem someone is having.

Will take time though.

Paul

Alex Jones

Friday 11 July 2003 9:25:27 am

Good points in both replies. As I mentioned, I am concerned that the documentation is not left behind. For that matter, I am excited about the ability to add comments to the documentation as I have found it quite a useful feature for the PHP docs myself.

So, modifying my initial ideas a bit... I would love to see an improved method of displaying new comments/additions to the documentation, which as Karsten mentioned is in the works. Woohoo! :)

Well, as I was writing an extended paragraph discussing why I still want a Tip & Tricks area I realized that the Contributions section matches what I am looking for, I just hadn't connected the two. It has been a looooong week.

Alex

Alex
[ bald_technologist on the IRC channel (irc.freenode.net): #eZpublish ]

<i>When in doubt, clear the cache.</i>

Bård Farstad

Friday 11 July 2003 10:38:50 am

Mabye a tips and tricks forum could be the incoming are for the docs. We could then make a documentation page and organize tips after they're discussed.

--bård

Documentation: http://ez.no/doc

Powered by eZ Publish™ CMS Open Source Web Content Management. Copyright © 1999-2014 eZ Systems AS (except where otherwise noted). All rights reserved.