Better Module Documentation In The Forge

General project discussion. NOT for help questions.
uniqu3

Re: Better Module Documentation In The Forge

Post by uniqu3 »

Dr.CSS wrote: Yes it would have to be a Dev. team member as I said the forge is quite different than other set ups, sorry...
But as first step a volunteer Team could be aranged that could at least, write better descriptions, upload screenshot, place a note about min or max cmsms version and note dependencies.
We hope that some time later (better sooner) forge will be rewamped, but for the time being, a voulenteer team could spend some time optimizing what with current forge could be possible to optimize.
Last edited by uniqu3 on Tue Dec 14, 2010 6:52 pm, edited 1 time in total.
Wishbone
Power Poster
Power Poster
Posts: 1368
Joined: Tue Dec 23, 2008 8:39 pm

Re: Better Module Documentation In The Forge

Post by Wishbone »

I like the idea of uploading screenshots of admin panels, and front-end usage. Would be nice to have links to sites that are using the module so that the prospective module user can see the module in action on a live site. It might be nice to make the above mandatory before releasing a new module, or updating an existing one.

Would be nice to be able to filter out 'Stale' modules, or only show modules compatible with later releases. It would be hard to test each module after each CMSMS release, but we can send mail to module owners and have them test. If no response after a module is 2 (or whatever) major releases old, it goes stale, etc.

There are a lot of obscure, 'boutique', modules, but also a lot of mainstream, well supported modules that a lot of us use. We can create a page in the documentation describing common modules, how to use them, etc.. A directory of "you want to do this? Here's what you need to do."

We keep on hearing in the documentation section that "this would be nice, but there are no volunteers to do this kind of thing", but if the above capability is available with the site software, I'm sure that we can find volunteers. uniqu3 and I wouldn't be enough, but it's a good start, and better than nothing. Please let us know if any of the above features are possible in the forge, and if so, I can get started right away.
Last edited by Wishbone on Tue Dec 14, 2010 7:03 pm, edited 1 time in total.
User avatar
Dr.CSS
Moderator
Moderator
Posts: 12711
Joined: Thu Mar 09, 2006 5:32 am

Re: Better Module Documentation In The Forge

Post by Dr.CSS »

You can do all this in the wiki, make pages for modules and do all you want, images etc...
Wishbone
Power Poster
Power Poster
Posts: 1368
Joined: Tue Dec 23, 2008 8:39 pm

Re: Better Module Documentation In The Forge

Post by Wishbone »

Is there currently a section for modules? I can only seem to find plugins and UDTs.. Is it possible to edit module descriptions in the forge and create links to the module's wiki page?
Jos
Support Guru
Support Guru
Posts: 4019
Joined: Wed Sep 05, 2007 8:03 pm

Re: Better Module Documentation In The Forge

Post by Jos »

The section for modules can be found here http://wiki.cmsmadesimple.org/index.php ... ns/Modules
uniqu3

Re: Better Module Documentation In The Forge

Post by uniqu3 »

Wiki is fine as long there would be links added in the Forge leading to Wiki from module description, without links it's just another "construction zone" lost somewhere that maybe 5% of users that actually look for it will find.
HansDampf
Forum Members
Forum Members
Posts: 60
Joined: Sun Nov 28, 2010 10:07 am

Re: Better Module Documentation In The Forge

Post by HansDampf »

Jos wrote: @HansDampf: http://dev.cmsmadesimple.org/project/list/module doesn't show the project tags, but the main page of the Forge does: http://dev.cmsmadesimple.org/
I am sure you agree with me that a "normal user" would browse this way:

www.cmsmadesimple.org => Downloads | Modules and then he is lost.
Where are the tags?

How to find that there is a dev-zone?
Why should a user assume that he has to go to  a "dev-zone"? He is a user, not a developer (even when he knows that "dev" is abbreviation of "developer" )

It's all about usability ;=(

I could list a long list of misleading or unexpected navigation at the website,

for example try to find info about menu-configurations (I tried to search the website, but there is "documentation + FAQ + IRC +++ and the real info is in "Downloads => CMSMS Theme Site => How To => Menumanager Styling => Variations with MenuManager"... at least that was the only useful info I as a humble user could find ....
Jos
Support Guru
Support Guru
Posts: 4019
Joined: Wed Sep 05, 2007 8:03 pm

Re: Better Module Documentation In The Forge

Post by Jos »

HansDampf wrote: I am sure you agree with me that a "normal user" would browse this way:

www.cmsmadesimple.org => Downloads | Modules and then he is lost.
Where are the tags?
If you put it this way... I agree  ;)
HansDampf
Forum Members
Forum Members
Posts: 60
Joined: Sun Nov 28, 2010 10:07 am

Re: Better Module Documentation In The Forge

Post by HansDampf »

Dr.CSS wrote: You can do all this in the wiki, make pages for modules and do all you want, images etc...
I always thought CMSMS means "ContentManagement MadeSimple" but the website here is a very bad example of ContentManagement unfortunately

now you throw the WIKI into the arena

this is the next part of documentation which is hidden, which is only known by insiders, which is not linked in the frount page of wwwl.cmsmadesimple.org (if I am wrong it shows how bad the organisation is)

yes, we all can pour knowledge in many pots, in front row and in back row, in hidden caves or in full public front page .. who guarantess any standard, any compliant information, who can decide which is the uptodate info?
Wishbone
Power Poster
Power Poster
Posts: 1368
Joined: Tue Dec 23, 2008 8:39 pm

Re: Better Module Documentation In The Forge

Post by Wishbone »

HansDampf wrote: now you throw the WIKI into the arena

this is the next part of documentation which is hidden, which is only known by insiders, which is not linked in the frount page of wwwl.cmsmadesimple.org (if I am wrong it shows how bad the organisation is)
The documentation section is the wiki.
HansDampf
Forum Members
Forum Members
Posts: 60
Joined: Sun Nov 28, 2010 10:07 am

Re: Better Module Documentation In The Forge

Post by HansDampf »

ok, you see that is not clear

why not use the label which is the main navigation label for that?
Must I check the links to find out what could be meant?

Cheers, Hans
Sonya

Re: Better Module Documentation In The Forge

Post by Sonya »

Dr.CSS wrote: This has been hashed over many times before, and it's the same old thing, not enough people with the free time to work on it...
Sorry, but this "excuse" is used over and over here, when the "same old thing" comes up. I (and some other) have many times offered to work on it. There was never a response. In this topic here, there are 2 people who once more wish to invest their time. And?
Wishbone
Power Poster
Power Poster
Posts: 1368
Joined: Tue Dec 23, 2008 8:39 pm

Re: Better Module Documentation In The Forge

Post by Wishbone »

Sonya wrote: In this topic here, there are 2 people who once more wish to invest their time. And?
The wiki is a start.. I'm going to start documenting modules in a few days.
User avatar
Dr.CSS
Moderator
Moderator
Posts: 12711
Joined: Thu Mar 09, 2006 5:32 am

Re: Better Module Documentation In The Forge

Post by Dr.CSS »

I offer you to put them in the wiki as that is the place any can edit, the software running the forge is, I will say it again, not the easiest thing to change and access to it can't be given to just anyone if they have never used it before, why do you think it still looks like the old version of main site, imagine how long it took just to get alphanumerical navigation in top...
Sonya

Re: Better Module Documentation In The Forge

Post by Sonya »

Dr.CSS wrote: ... and access to it can't be given to just anyone if they have never used it before.
OK, I can understand it.

Your first answer in this topic sounds like "we do not have enough people who would do it." The right answer is: "development team does not have enough time to do it and no, we do not wish any help, as we do not give access rights to anybody accept devs". Just wanted to point it out, so that other people know that they cannot help with forge unless they belong to dev team.
Locked

Return to “General Discussion”