The secure CMS.
Resources
Topics
- Home
- Development (317)
- Geeklog (209)
- Plugins (111)
- Themes (2)
- News (387)
- Announcements (248)
- Geeklog.net (31)
- Security (76)
- Spam (11)
- Summer of Code (26)
User Functions
Events
What's New
Stories
No new storiesComments last 2 weeks
No new commentsTrackbacks last 2 weeks
No new trackback commentsLinks last 2 weeks
No recent new linksNEW FILES last 14 days
No new filesWelcome to Geeklog Tuesday, May 21 2013 @ 07:48 PM EDT
Geeklog Documentation
- Wednesday, June 30 2004 @ 01:54 PM EDT
-
- Contributed by:
- tomw
-
- Views:
- 5,718
Thats about all the Geeklog Documentation efforts have resulted in so far. After reading amckay's Beginner's Guide to Programming Geeklog, I was prodded to do something about it. So I set up a wiki for Geeklog Documentation. I have almost finished adding the Plugin Developer's Guide and have fleshed out an outline. I have other scattered documentation I will add and plan on incorporating the current Geeklog Documentation into the wiki. That, however, is far from adequate. So now I am asking for your help completing it.
You can find the wiki at http://www.pigstye.net/wiki and soon you can reach it at http://wiki.geeklog.net. Go there, sign up and you can immediately start adding/editing stuff. The wiki is MediaWiki which has capability to upload and use graphics. Have at it. I installed the wiki and added most of the Plugin Guide in about an hour, its not hard.
Plugin developers and programmers -- log on to the Wiki and create a page about your plugin and point to where you can download it, where to find support, etc.
Besides people like myself who looks at things from a programmers point of view, we need users and administrators to fill in the holes. So come on, quit gripping about the docs and do something about it. If you have trouble finding the answer to something, add it to the wiki when you do.
Oh and by the way, don't think that my outline and postings are the last word, add to it, rearrange it, whatever. If you find a mistake change it, if you have an addition or note add it. If it would be usefull to someone else, by all means it should be there. Lets make this great.
By the way, if english is not your native language and you want documentation in your native language, you are more than welcome to add it. If you want to do this, contact me and I will give you some guidelines and expanded privilages so that you can moderate your language version.
The following comments are owned by whomever posted them. This site is not responsible for what they say.
---
www.geeklog.now.pl
I was thinking we should eventually have a page for each and every GL function maybe? That way people can comment on their use of it and so on, kinda like the PHP online manual.
---
www.geeklog.now.pl
---
-- destr0yr - "People like you are the reason people like me need medication."
Thanks for the contributions you have already made.
TomW
But, I started typing all little things I noticed and realized, doc page becomes clogged too much
I added one note here for obvious thing which happens with me always and under all hostings, and then thought one more note about checking permissions, under installation steps, there is an advise for check.php script. It is currently running not correctly, so first my move was to write it, like this
NOTE: As of 1.3.9sr1 version, running check.php will help you to identify whether permissions are set correctly only till you get an error regarding SQL. Once SQL related error occurs, download error.log and read the error. It will mean that permissions for logs/ folder are set and geeklog writes to it. But errors regarding SQL are not for you to worry at that point, omit it for now and go to the step 4
But then I removed it from there, since I started thinking that at the same spot I have to describe how to correct errors, which error is good and which is not, what to do etc. It may become a 2 page story just describing a current work of one script, while it may all change in the next version
So, having said all of this, my questions are:
1. Should we have a version related errors file or how wiki doc will change if 1.3.10 will be released and function differently
2. If someone spots a bug or an error, is Documentation is a write space for describing it and if yes, what spot? Should it be under Problems? May be version differencies? I remember from previous installations, there are numerious little but important changes from version to version and automatic updates not always catch them
3. Not related, but ... What about security? I registered my account and even without proving an email I was logged on immediately to edit stuff. What if someone will delete or add advertisement entries all over the place?
That's a problem all Wikis face. But since the Wiki tracks all the changes, spam and vandalism are easy to undo.
bye, Dirk
Thank you for your contributions and to the others who have been adding things. If you havn't been by to look come look, its starting to take shape.
tomw
---
www.geeklog.now.pl
On the other hand, I still don't think clogging main page with installation by little notes with version differencies will appropriate
Is there a way at least to show "talk" comments added to the bottom of the main page, like comments in geeklog, or, may be have significant ones as sub-pages, under the main page?
---
www.geeklog.now.pl
- So far we have 35 registered users.
- 12 users have made contributions.
- There are about 80 pages so far.
- 481 edits so far.
- 2646 Page views.
Of course that is nowhere near complete, but at this point it is starting to get useful.If you havn't made a contribution, please stop by. We are in most need of basic howtos, user and admin instructions.
TomW
---
tokyoahead.com
bye, Dirk