Documentation



  • Jim,
    2.0 is exceptional.
    It is obvious that many very talented people have spent and continue to spend an enormous amount of time on this project.
    2.0 is progressing nicely and it's evident that the development team won't call it finished until it's absolutely right. 
    Kudos to the team.
    Having spent days reading this forum, both books, and many other sites, it is clear that the subject of documentation needs to be addressed.
    If it is intended that this software be used by "non comp sci educated" "non-network types" then the documentation requires significant attention.
    As a representative example,  volumes are written regarding bridging.  Confusion abounds.  And this
    http://doc.pfsense.org/index.php/Interface_Bridges
    is the documentation.
    I realize that documentation is always last, that's understood.
    And perhaps this software is not intended for general consumption. 
    Should that be the case please disregard and excuse the comment.
    Enough said.



  • I'd be willing to help on documentation, but I don't know how much income is derived from book sales.  The goal might be to fund the project via documentation, in which case I don't want to screw things up for anyone.

    (Yes, I bought the book.  :) )



  • @Derek:

    I'd be willing to help on documentation, but I don't know how much income is derived from book sales.  The goal might be to fund the project via documentation, in which case I don't want to screw things up for anyone.

    That's an important source of funding but we encourage people to contribute openly - there is a lot of work remaining to be done with the contextual help pages for instance (the ? links on every page in 2.0). For those willing to help, if you don't already have an account on doc.pfsense.org, just email wikiadmin at pfsense dot org with your desired username and we'll setup an account for you (self-registration disabled thanks to incredibly persistent spammers).


  • Rebel Alliance Developer Netgate

    What kind of information were you expecting to see on that page? There are some other articles in the "Bridging" category (click the link at the bottom of that wiki page) : http://doc.pfsense.org/index.php/Category:Bridging

    There is always room for improvement of course, but the book will always be the official source of the most complete information.

    If there are specific topics that people would like covered on the wiki or to expand existing wiki pages, we're always open for suggestions (or even better, volunteers to write the content).


Log in to reply