in reply to Re^3: Open sourcing perlmonks
in thread Open sourcing perlmonks

To be honest, intuitive is only because you've been doing it a long time.

Well, im not sure that I agree with you. I found the PmDev Nodelet to be quite intuitive. It shows you the basic data on the type of node you are viewing, what display page associated to that nodetype was used for rendering the page, it give you ways to view the code of the node being rendered if its relevent, abilities to show the container structure, view the type heirarchy, view lists of nodes by type and to view the master list of site patches. All of this on top of being able to search the full codebase of the site, (with grep capabilities) and links to offsite documentation which although not specific to PM is still very useful.

Im not sure what of the above isnt intuitive. Maybe if I did I could document it better. :-)

---
$world=~s/war/peace/g

Replies are listed 'Best First'.
Re^5: Open sourcing perlmonks
by Tanktalus (Canon) on May 28, 2005 at 18:05 UTC

    First off, intuitive is all in the eye of the beholder. Which is what I was saying about my perl project at work.

    Second, when I first wanted to do the vote patch, it did take me a few days to figure my way around things. If there was a document like this to explain even just the PmDev Nodelet, it would have been nice to have:

    #xxxxxx
    Node number being used to display the current document.
    = <node type>
    Type of document the above node is see this to see an explanation of all the node types.
    via <blah>
    I'm not sure what this is... here is a document that explains the different types
    Dump Fields
    Dumps the fields - you can only dump all the data about the current node if you have certain authorities which are ...
    ...
    ...
    Everything Bible
    Mandatory reading - too bad it's too new for the level of Everything we're using here.
    ...
    ...
    And, of course, there'd be an extra entry - "PmDev Help" - that would point to this doc. But, really, what I was referring to that I thought was not intuitive is just following around all the code. On one hand, it's great - it's hugely modular. On the other hand, a web browser is not the most conducive method for reading/writing code that is spread out all over the place ;-)

      You'll see a new link in the pmdev nodelet to the pmdev howto wiki. Please add or update whatever you think is relevent. Ive done a first go at explaining the pmdev nodelet itself, maybe you could add whatever you think is relevent.

      ---
      $world=~s/war/peace/g