Wiki cleanup / reorganization with new release strategy - CHDK Releases - CHDK Forum supplierdeeply
« previous next »
Pages: [1] 2 3   Go Down

Wiki cleanup / reorganization with new release strategy

  • 22 Replies
  • 11263 Views
*

Offline reyalp

  • ******
  • 14080
Wiki cleanup / reorganization with new release strategy
« on: 04 / February / 2012, 17:55:24 »
Advertisements
One issue not yet resolved is how to deal with wiki pages for release vs development branches.

There is also a lot of outdated and redundant information on the wiki. I'd like to see this consolidated, deleted or at least moved to some obscure location.

I would like to keep documentation for the releases somehow, while still being able to document features as they are added to the new releases.

Ideally, the default documentation that users see should be for whatever branch is currently recommended for end users.

I'm not sure the best way to accomplish this, open to suggestions.

As a first step, it would be good to figure out what pages need to be release specific

Very release specific pages
- User manual http://chdk.wikia.com/wiki/CHDK_User_Manual
- Firmware usage pages
http://chdk.wikia.com/wiki/CHDK_firmware_usage
http://chdk.wikia.com/wiki/CHDK_firmware_usage/MoreBest
http://chdk.wikia.com/wiki/CHDK_firmware_usage/AllBest

Following  this pattern, I'm thinking the user manuals should be
- CHDK_User_Manual  <- current recommended release (usually stable, until dev branch reaches RC phase)
- CHDK_User_Manual/Development <- current development branch. Contents can be copy/pasted to main page when it becomes the recommended release)
- CHDK_User_Manual/Release 1.x etc <- old releases

Somewhat release specific
- Scripting pages
http://chdk.wikia.com/wiki/Script_commands
http://chdk.wikia.com/wiki/Scripts
http://chdk.wikia.com/wiki/Lua and sub pages
+ more, which should be cleaned up/ consolidated. It may be enough to add release specific notes to each one. The function reference pages are already large and difficult to work with, it might be better break them up into a few categories.
- Faq
http://chdk.wikia.com/wiki/FAQ - installation related items
- Various intro articles
http://chdk.wikia.com/wiki/CHDK_in_Brief
http://chdk.wikia.com/wiki/CHDK_for_Dummies
It seems like these should be consolidated and obsolete ones removed

There's a lot more, I'd appreciate people listing what they can think of here. If we pick a strategy and work on it a bit at a time, I think we can make things a lot better. If current community members need wiki admin rights to help accomplish this, I'm happy to set this up.
Logged
Don't forget what the H stands for.
*

Offline waterwingz

  • ******
  • 12139
    • Waterwingz
Re: Wiki cleanup / reorganization with new release strategy
« Reply #1 on: 04 / February / 2012, 18:23:14 »
Quote from: reyalp on 04 / February / 2012, 17:55:24
There is also a lot of outdated and redundant information on the wiki. I'd like to see this consolidated, deleted or at least moved to some obscure location.
AFAIK,  a wiki has no "structure".  Its just pages that may or may not be linked together. Although you can search across all pages.  Yes - I just stated the obvious.  But it seems that we should focus on pages that connect from the main page and get those cleaned up.  The rest will just be "in the void" although a generic Notice Box at the top of each stating "This page may be obsolete.  It is left here for historical purposes"  should serve as enough of a warning to the novice.  There are probably only 400 or pages that need that tag ?

Quote
There's a lot more, I'd appreciate people listing what they can think of here. If we pick a strategy and work on it a bit at a time, I think we can make things a lot better. If current community members need wiki admin rights to help accomplish this, I'm happy to set this up.
Other than the main http://chdk.wikia.com/wiki/CHDK page,  the one that might need the most TLC is the FAQ page?  I've been keeping my own file of "links" that I c&p into questions on the forum - saves a lot of typing.  After about a year of doing that,  its probably a more accurate "FAQ" list than the actual FAQ.  I was thinking of maybe putting them in list of "Frequently Requested Links" at the top of the FAQ page ?
Logged
Ported :   A1200    SD940   G10    Powershot N    G16
*

Offline reyalp

  • ******
  • 14080
Re: Wiki cleanup / reorganization with new release strategy
« Reply #2 on: 11 / February / 2012, 18:19:29 »
Quote
(User rights log) . . ReyalP (Talk | contribs | block) changed group membership for User:Waterwingz from (none) to Administrators
The beatings will continue until moral improves.

We had some discussion on improving the scripting pages. IRC dump:
Code: [Select]
< waterwingz> reyalp :  per our earlier chat about SD card wiki pages ... seems like it would be nice to figure out how to
                    impose some sort of structure on the wiki scripting pages ...
< reyalp> yes
< reyalp> we should have a centralized reference for all the scripting functions. This is too big for one page, but one page
                per function is probably too much
< reyalp> http://chdk.wikia.com/wiki/Script_commands is a good start
< reyalp> lua vs ubasic difference also need to be covered, somehow
< waterwingz> just started by linking http://chdk.wikia.com/wiki/Scripts from the main features on the home page
< reyalp> there should also be some information on how functions like shooting override, key functions etc work
< waterwingz> reorganized http://chdk.wikia.com/wiki/Scripts from a user perspective
< reyalp> we can probably group the script functions, e.g. exposure control, keyboard etc
< reyalp> the distinction between "new" script commands and others should go away
< reyalp> examples that are more than a couple of lines should be relagated to their own pages imo, not included in general
                reference
< waterwingz> yes

And also the bootable SD card section
Code: [Select]
< waterwingz> reyalp ? :   any thoughts on how to clean up this page :  http://chdk.wikia.com/wiki/Bootable_SD_card  - we
              really need to do a better job of explaining what to do with the new cameras that support FAT32 booting - the
              format / install via firmware update / use CHDK menu to make the card bootable should maybe be the default
              description
< waterwingz> then tell people about CardTricks and SDMinste.exe and Licks for Linux
< waterwingz> then - and only then - all the low level stuff that is on the current page ?
< waterwingz> then the various CHDK manuals need change too I guess

< reyalp> waterwingz: [youtube]aCbfMkh940Q[/youtube]
< waterwingz> thought so -  but you know what happened the last time you shared that link with me
< reyalp> I think it should have 1) description of what actually needs to be done: BOOTDISK string, lock, diskboot.bin on card
< reyalp> partition if needed
< reyalp> 2) links to the best tools for each platform
< reyalp> 3) alternative methods (maybe)
< waterwingz> the firmware update / CHDK menu choice would be the cleanest
< waterwingz> not sure it always works though
< waterwingz> and not for dual partition cards for sure
< reyalp> yeah, that should probably be first before the OS methods, but have to note where it doesn't work
< reyalp> if we want to have details for the different methods, they could be sub pages, e.g. Bootable_SD_card/hexed or whatever
< waterwingz> were we get caught on that is new versions that don't have a ps.fi2 file ... and those are usually the versions that other
              newbies are trying to boot for the first time too
< reyalp> yes, it is actually kind of complicated to cover all the cases :/
< waterwingz> sub-pages or just push down to the bottom of the main page -  my thinking there is the "random" order that wiki search
              finds pages - you would not want somebody to find the sub-page first
< waterwingz> (looks like wiki search now finds only the valid USB remote page for example - but that's mostly because of the cleanup you
              and fe50 did )
< reyalp> The subpages can/should link back to the overview page
< reyalp> I think this happens automatically when you use /
< waterwingz> so there is an annotation added automagically at the top of the page ?
< reyalp> http://chdk.wikia.com/wiki/Lua/Lua_Reference
< reyalp> Should probably also have a boilerplate that says "this page tells you how to make a card bootable using X on Y, for an
                alternative methods see..."
Logged
Don't forget what the H stands for.
*

Offline outslider

  • *****
  • 762
Re: Wiki cleanup / reorganization with new release strategy
« Reply #3 on: 11 / February / 2012, 20:43:13 »
Some time ago I made stub for new description of script commands:
http://chdk.wikia.com/wiki/Script_commands_stub

I had no time to enlarge this...
Logged
if (2*b || !2*b) {
    cout<<question
}

Compile error: poor Yorick
*

Offline waterwingz

  • ******
  • 12139
    • Waterwingz
Re: Wiki cleanup / reorganization with new release strategy
« Reply #4 on: 11 / February / 2012, 20:48:23 »
Quote from: outslider on 11 / February / 2012, 20:43:13
I had no time to enlarge this...
Seems to be a common problem ..
Logged
Ported :   A1200    SD940   G10    Powershot N    G16
*

Offline outslider

  • *****
  • 762
Re: Wiki cleanup / reorganization with new release strategy
« Reply #5 on: 11 / February / 2012, 22:11:41 »
But I did at least a startup:)
Logged
if (2*b || !2*b) {
    cout<<question
}

Compile error: poor Yorick
*

Offline waterwingz

  • ******
  • 12139
    • Waterwingz
Re: Wiki cleanup / reorganization with new release strategy
« Reply #6 on: 11 / February / 2012, 22:13:49 »
Quote from: outslider on 11 / February / 2012, 22:11:41
But I did at least a startup:)
hmmmm ... good ideas always help ... thanks for that .. but its the 98% of the hard work to fulfil the vision of those ideas that's hard ..
Logged
Ported :   A1200    SD940   G10    Powershot N    G16
*

Offline waterwingz

  • ******
  • 12139
    • Waterwingz
Re: Wiki cleanup / reorganization with new release strategy
« Reply #7 on: 11 / February / 2012, 23:41:36 »
« Last Edit: 11 / February / 2012, 23:55:49 by waterwingz »
Logged
Ported :   A1200    SD940   G10    Powershot N    G16
*

Offline outslider

  • *****
  • 762
Re: Wiki cleanup / reorganization with new release strategy
« Reply #8 on: 12 / February / 2012, 05:12:47 »
In my opinion new page should be created to completely describe possible cases:
<4GB cards
>4GB on cameras before~2011 (fat16+fat32)
>4GB on cameras after ~2012 (single fat32)

Then all other pages should be cleaned to avoid duplication of the content (excluding manual, which should be just updated). What do you think about?

Meanwhile I'll try to update commands stub, which I've started.
Logged
if (2*b || !2*b) {
    cout<<question
}

Compile error: poor Yorick
*

Offline waterwingz

  • ******
  • 12139
    • Waterwingz
Re: Wiki cleanup / reorganization with new release strategy
« Reply #9 on: 12 / February / 2012, 10:23:44 »
Quote from: outslider on 12 / February / 2012, 05:12:47
In my opinion new page should be created to completely describe possible cases:
<4GB cards
>4GB on cameras before~2011 (fat16+fat32)
>4GB on cameras after ~2012 (single fat32)
Then all other pages should be cleaned to avoid duplication of the content (excluding manual, which should be just updated). What do you think about?
That's pretty much what I'm doing.

Quote
Meanwhile I'll try to update commands stub, which I've started.
Would it not be good to have a discussion about how we want scripting wiki pages to be structured before you go to that much work ?
« Last Edit: 12 / February / 2012, 11:30:38 by waterwingz »
Logged
Ported :   A1200    SD940   G10    Powershot N    G16
Pages: [1] 2 3   Go Up
« previous next »
 

Related Topics