Thread Rating:
  • 0 Vote(s) - 0 Average
  • 1
  • 2
  • 3
  • 4
  • 5
Wiki Maintenance
#8
Much needed discussion I think. Good. let me weigh in too, but first of all let me say the discussion should be bigger still. GetSimple works really, really well. It is a fine piece of kit and the developers are doing a cracking job, but the project overall is behind and lacking in many ways:
  • The default themes are out of date, back and front end.
  • The default content could be improved
  • The GS.info site design seems good to me but much of the content is out of date.
  • Press releases have never been done since the beginning.
  • The whole 'route in' whereby users progress from taking a casual glance at GS, to looking in more detail, to spending half an hour trying it out, to beginning to learn to use it should be looked at and made smooth and easy. that applies to the site, the core program, the forum and the wiki.
  • And the wiki? Yes it's really important to make it good, so back on topic for this thread these are my thoughts.
Yes, the dokuwiki software could work better. Really good contribution from datiswous. We have no auto linking. All the links need to be put in manually. At the moment you navigate the wiki by looking down the index page like you would a paper manual but you should be able to progress through categories, keywords and searches and with a bigger wiki you would have to.

The structure - The Primary division in the index is by User Level (casual, beginner, user, developer) and that is the best primary structure but we lack secondary underlying categories. I mean if you want info on say the CKEditor the wiki pages are scattered through all the main sections and there is no way of progressing through them. The dokuwiki manual says that pages should be arranged and categorised in a logical directory tree ('namespace' in wiki-speak), whereas our pages are not. I am not clear how useful it would be and reorganising them would break every internal link through the wiki and from the main site and from the forum and from the GS Backend and you wouldn't want to try to do it with ordinary editing rights.

We have to accept that the wiki will always be a version behind the program unless releases are delayed while the documentation is prepared which would be dumb in our case.

Really, really good to flag up items the developers think might need documenting. I haven't always known what has changed or where to look. Remember not every change needs documentation. I have deleted a lot of statements like 'New in 3.0 is the slightly different...'

Plugins - YES. I was answering an email query last week and explaining that at least half the difficulty in learning to use GS is learning your way around Extend and the several hundred plugins. I still don't know it myself. We cannot have a user guide for Extend so what is the best way to deal with this? I was thinking maybe we need a series of articles like
  • Three ways to Blog with GS
  • Images Sliders and Galleries in GS
  • Getting feedback by emails and commenting in GS
We already have a couple like 'How to do SEO in GS' and 'Extra Security in GS'. I think they are useful.

Glossary, yes we have the beginning of one

FAQ - Excellent idea. Real FAQ (that are actually asked from time to time) please. I will start a thread to collect some.

Is there a case for splitting up the documentation? Into say
  1. Learning GS
  2. Reference

Got to go.
Reply


Messages In This Thread
Wiki Maintenance - by shawn_a - 2013-10-30, 07:19:20
RE: Wiki Mainenance - by shawn_a - 2013-10-30, 07:27:01
RE: Wiki Mainenance - by shawn_a - 2013-10-30, 07:32:48
RE: Wiki Mainenance - by shawn_a - 2013-10-30, 23:32:45
RE: Wiki Mainenance - by shawn_a - 2013-10-31, 03:42:00
RE: Wiki Mainenance - by datiswous - 2013-10-31, 13:15:33
RE: Wiki Mainenance - by datiswous - 2013-10-31, 14:03:05
RE: Wiki Mainenance - by Timbow - 2013-10-31, 21:08:51
RE: Wiki Mainenance - by datiswous - 2013-11-03, 10:55:09
RE: Wiki Mainenance - by shawn_a - 2013-10-31, 23:29:58
RE: Wiki Mainenance - by shawn_a - 2013-10-31, 23:31:13
RE: Wiki Mainenance - by hameau - 2013-11-01, 03:42:22
RE: Wiki Mainenance - by shawn_a - 2013-11-03, 11:27:57
RE: Wiki Mainenance - by datiswous - 2013-11-06, 07:16:15
RE: Wiki Mainenance - by datiswous - 2013-11-15, 21:50:47
RE: Wiki Mainenance - by n00dles101 - 2013-11-15, 22:00:45
RE: Wiki Mainenance - by datiswous - 2013-11-26, 05:00:06
RE: Wiki Mainenance - by shawn_a - 2013-11-26, 05:51:50
RE: Wiki Mainenance - by datiswous - 2013-11-30, 08:02:14
RE: Wiki Mainenance - by shawn_a - 2013-11-30, 08:27:21
RE: Wiki Mainenance - by Everyone - 2014-01-04, 00:42:53
RE: Wiki Mainenance - by shawn_a - 2014-01-04, 01:56:19
RE: Wiki Mainenance - by Everyone - 2014-01-04, 23:57:57
RE: Wiki Mainenance - by Everyone - 2014-01-05, 01:01:27
RE: Wiki Mainenance - by shawn_a - 2014-01-05, 08:42:55
RE: Wiki Mainenance - by Everyone - 2014-01-09, 08:55:44
RE: Wiki Mainenance - by shawn_a - 2014-01-10, 05:44:40
RE: Wiki Mainenance - by datiswous - 2014-01-14, 00:07:43
RE: Wiki Mainenance - by shawn_a - 2014-01-14, 00:21:35
RE: Wiki Mainenance - by datiswous - 2014-01-16, 08:41:37
RE: Wiki Mainenance - by shawn_a - 2014-01-16, 08:56:08
RE: Wiki Mainenance - by datiswous - 2014-01-16, 09:17:59
RE: Wiki Mainenance - by shawn_a - 2014-01-16, 10:40:48
RE: Wiki Mainenance - by shawn_a - 2014-01-18, 00:23:34
RE: Wiki Mainenance - by datiswous - 2014-01-18, 09:51:02
RE: Wiki Mainenance - by shawn_a - 2014-01-31, 00:34:38
RE: Wiki Mainenance - by shawn_a - 2014-01-31, 00:36:12
RE: Wiki Mainenance - by datiswous - 2014-02-13, 20:33:00
RE: Wiki Mainenance - by shawn_a - 2014-02-13, 23:59:37
RE: Wiki Mainenance - by shawn_a - 2014-03-05, 03:17:43
RE: Wiki Mainenance - by datiswous - 2014-03-06, 11:00:20
RE: Wiki Mainenance - by shawn_a - 2014-03-06, 11:26:04
RE: Wiki Mainenance - by datiswous - 2014-03-06, 13:37:02
RE: Wiki Mainenance - by shawn_a - 2014-03-08, 05:25:07
RE: Wiki Mainenance - by shawn_a - 2014-07-24, 06:24:23
RE: Wiki Mainenance - by Timbow - 2014-07-24, 07:13:11
RE: Wiki Mainenance - by shawn_a - 2014-07-24, 10:01:51
RE: Wiki Mainenance - by datiswous - 2014-12-02, 20:28:39
RE: Wiki Mainenance - by datiswous - 2015-01-23, 05:51:49
RE: Wiki Mainenance - by shawn_a - 2015-01-23, 06:31:58
RE: Wiki Mainenance - by datiswous - 2015-01-23, 06:40:30
RE: Wiki Mainenance - by shawn_a - 2015-01-23, 06:55:03
RE: Wiki Mainenance - by shawn_a - 2015-01-23, 07:29:39
RE: Wiki Mainenance - by datiswous - 2015-01-23, 07:35:01
RE: Wiki Mainenance - by shawn_a - 2015-01-23, 07:36:32
RE: Wiki Mainenance - by shawn_a - 2015-01-23, 07:37:17
RE: Wiki Mainenance - by datiswous - 2015-01-23, 08:07:16
RE: Wiki Mainenance - by Carlos - 2015-01-24, 20:27:39
RE: Wiki Mainenance - by shawn_a - 2015-01-25, 00:52:00
RE: Wiki Mainenance - by datiswous - 2016-04-25, 19:58:26
RE: Wiki Mainenance - by datiswous - 2016-04-29, 20:14:17
RE: Wiki Mainenance - by shawn_a - 2016-04-29, 23:06:17
RE: Wiki Mainenance - by datiswous - 2016-04-30, 06:27:54
RE: Wiki Mainenance - by datiswous - 2016-06-15, 22:02:03
RE: Wiki Mainenance - by ferby - 2016-07-01, 20:13:25
RE: Wiki Mainenance - by shawn_a - 2016-07-01, 22:06:53
RE: Wiki Mainenance - by ferby - 2016-07-01, 22:44:09
RE: Wiki Mainenance - by shawn_a - 2016-07-01, 23:01:31
RE: Wiki Mainenance - by shawn_a - 2016-07-01, 23:16:17
RE: Wiki Mainenance - by datiswous - 2018-03-01, 11:05:34



Users browsing this thread: 1 Guest(s)