Jump to:

4945 Posts in 17789 Topics by 1494 members

Installing SilverStripe

SilverStripe Forums » Installing SilverStripe » Documentation Sucks for newbies

Getting SilverStripe up and running on your computer and on your web server.

Moderators: martimiz, Sean, biapar, Willr, Ingo, swaiba, simon_w

Page: 1
Go to End
Author Topic: 2007 Views
  • Gravitational FX
    Avatar
    Community Member
    22 Posts

    Documentation Sucks for newbies Link to this post

    I'm quickly loosing confidence in being able to create websites in SS because of the poor documentation.

    I can't seem to get modules such as Newsletter or Gallery working. I'm sure if there was bettwer documentation then I'd be able to get it all up and running.

    Things that are missing as regards to documentation are:
    Where exactly do you place the extraced folders and files
    What do you need to rename (a lot of support docs say "oh - you need to rename the folder blah blah..)
    Which file do you need to edit to include the updates (_config.php - but which one in which folder structure)
    Which release of SS does a particular module support
    What are the latest trunk releases and where do you extract the files to?

    Screen dumps of the major steps would be very welcome.

  • Sam
    Avatar
    Administrator
    679 Posts

    Re: Documentation Sucks for newbies Link to this post

    I agree that it would be great to get these modules to a more polished state. However, the lack of documentation is one of the reasons why those modules are listed in the "unsupported modules" section.

    Realistically, getting these modules more polished in the near future is probably only going to happen if someone puts up their hand and offers to do this work.

    If anyone is interested, posting to http://groups.google.com/group/silverstripe-dev would be appropriate.

  • Willr
    Avatar
    Forum Moderator
    5511 Posts

    Re: Documentation Sucks for newbies Link to this post

    Where exactly do you place the extraced folders and files. What do you need to rename (a lot of support docs say "oh - you need to rename the folder blah blah..)

    There is no general 'How to Install Modules' page with 'Just extract it to the root folder, heres a screenshot of what the folder structure should look like'. Its really straightforward but if you have never done it before you still have to find out somewhere. Each INSTALL file contains the instructions but it would be handy to just have a global install info page. I might knock one up tonight.

  • Gravitational FX
    Avatar
    Community Member
    22 Posts

    Re: Documentation Sucks for newbies Link to this post

    A general "How to install modules and trunk builds" would be very very helpful.

    Thanks for your reply.

  • Gravitational FX
    Avatar
    Community Member
    22 Posts

    Re: Documentation Sucks for newbies Link to this post

    Hi Sam..

    I don't mind writing up some documentation on how to use the modules etc. if this is all that's standing in the way of them being supported modules.

    At the moment, I'm going to be using the newsletter, gallery and google analytics modules or code to implement some websites.
    Let me know what I would need to do to help contribute.

    Regards,
    Wil.

  • Willr
    Avatar
    Forum Moderator
    5511 Posts

    Re: Documentation Sucks for newbies Link to this post

    I have started a basic overview to installing modules on the wiki - http://doc.silverstripe.com/doku.php?id=installing-modules

    If I have missed anything or you believe a part could be expanded on / tidied up I fully recommend you add your thoughts to that installation page.

  • Sam
    Avatar
    Administrator
    679 Posts

    Re: Documentation Sucks for newbies Link to this post

    Thanks for the offer to help with docs, Gravitational FX.

    The following wiki pages provide the documentation as it currently stands:
    http://doc.silverstripe.com/doku.php?id=modules:newsletter
    http://doc.silverstripe.com/doku.php?id=modules:googleanalytics

    You can sign up for an account on the wiki to edit those pages.

    As for whether that's all that stands in the way of them being supported modules, well, no, it isn't - you also need someone who is going to fix bugs, etc! However, we are trying to find a maintainer for the googleanalytics and newsletter modules right now.

    2007 Views
Page: 1
Go to Top

Want to know more about the company that brought you SilverStripe? Then check out SilverStripe.com

Comments on this website? Please give feedback.