Difference between revisions of "Talk:Geeklog 1.3x Documentation"

Latest revision as of 22:28, 21 November 2005

User:Netbuster I was excited to learn about this Wiki project and decided to add some personal experiences, as i just refreshed my memory by recent upgrade to 1.3.9 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?

TomW Here are my suggestions for these questions:

1. It is very easy to make a new page just refer to it. I would suggest that version specific notes be included on their own page like this [[ModulePageSubjectEtc 1.3.8 note]]
2. It doesn't matter on things like this, perhaps we could add a page to each update page for gotcha's like this. Be the first and start the trend.
3. Security is not a big issue. I will keep an eye on it, as sysop I have the ability to ban users and ips and I will. The wiki keeps a history and I make a daily backup also, so I can get back to previous versions.

Still unclear how to post

Hi ALL

I went ahead and posted a gotcha for check.php

http://wiki.geeklog.net/wiki/index.php/Talk:Installation_Instructions

I thought, I did it right way, I went first to the page I wanted to add my gotcha, which is this one:

http://www.pigstye.net/wiki/index.php/Installation_Instructions

And pressed "Discuss this page"

where I typed all my text and submitted

But when I went back to the main page, nowhere it states that there is note linked to that page and of course no name mentioned, so it will be a real coinsidence if someone will click to "Discuss..." link to see my note and have a problem discussed there, so my note will be helpful

I see some options used (like linked pages) but how I can link those notes?

or, may be I can make a fresh page and position it under the page it discusses? The How?

Please advise!

Adding pages so they're visible

Robert Netbuster, if you want to add a subpage to any page in the wiki you do the following:

1. Go to this page e.g. Installation Instructions
2. You read it and want to add some thoughts of yours and call it CHECK.PHP GOTCHA. OK
3. So you clik on Edit this page.
4. In the editor you go to the bottom of the text and enter e.g. this [[CHECK.PHP GOTCHA]]
5. You save the page
6. After saving there will be a new link at the bottom of Installation Instructions page, called CHECK.PHP GOTCHA leading to a new page you gotta fill with the content
7. When you click on the link you will see an editor field waiting for you insights on any subject

Hope that helps.

PS I've started with wiki thing a year ago and I quit because couldn't understand how it works. Now after Tom has set this up I started slowly to read the wiki docs and found it very simple to use. Really after adding two or more pages you'll get there.

New Layout Of 1.3x Index Page

Robert I was just wondering whether we could collapse the index page a little bit, and hide all subthings under the appropriate main sections. Something like I did for Introduction.

That would make the navigation easier I guess. Any comments?

Also I would like the list of plugins ordered alphabetically.

Tokyoahead

Good Idea. Both of them. Maybe there could be a sitemap however which lists all topics. The Wiki is providing this already, no? So maybe a link to that would be good.

TomW

We could make the collapse the index page by making the subheadings on different pages. Then when we clicked on the subheading a page would show with the links under the subheading. However, I would want it both ways, I like being able to look down the list and see the depth. Maybe have a second abreviated index page with links to sub sections of the index. But then we have two things to maintain. I will look and see if the automatic toc feature can be used for this.

If you want the plugins arranged alphabetically, just edit the index page and do so -- doesn't matter to me.

TomW

I just had an idea about how we could make the menu expanding. Make each of the major headings lead to a sub page like Robert made for the Intro section but make it include all the other main headings not expanded. Then you would not have to go back to the main page to access the other sections. I will modify Roberts intro page to show what I mean. Comments?