Personal tools
You are here: Home Developer Developer Forum Architecture Team New Documents in Architecture Team Area

New Documents in Architecture Team Area

Up to Architecture Team

New Documents in Framework Team Area

Posted by Kirsten Menger-Anderson at September 22. 2008

Hi-

I moved a number of framework-related docs from the old wiki to a new folder called "Archive" in the Framework area of the new wiki. Each is clearly marked with an outdated status (see https://dev.kepler-project.org/developers/teams/framework/archive/kepler-repository for an example).

Over in the user outreach forum, we've been talking about noting the status of specifications more clearly, and we came up with the idea of three general categories for pages (now noted on the Framework home page): Work in Progress (for current work); Technical Documentation (for documentation of completed work), and Archive (for out-of-date material--in this case stuff moved from the old site that needs review before it can be updated to current. I thought using colored icons at the top along with a text message could reinforce the status even more firmly. Will this system work for you? Do you have any additional thoughts or concerns? Note that some of the pages might not be properly categorized, in which case, please feel free to move them to the correct place. Thanks for your thoughts,

kirsten

 

Re: New Documents in Framework Team Area

Posted by Aaron Schultz at September 22. 2008

 

 

Hi Kirsten, this is a great idea!  I wonder if we need the symbol for current work though.  This would mean that every contributor to the site would have to remember to include the blue image and note when they create a new page.  Perhaps if there was a style that could include that content automatically or better yet, every new page automatically started with a template that had the blue triangle there already then folks would not forget to include it.

 

Aaron

Re: New Documents in Framework Team Area

Posted by Aaron Schultz at September 22. 2008

Kirsten,

I don't think we need to distinguish between current work and "technical documentation".  This is the developer part of the site so it is all technical documentation.  So really only the red triangle is needed I think.  To mark things as outdated.

Thanks,

Aaron

Re: New Documents in Framework Team Area

Posted by Kirsten Menger-Anderson at September 23. 2008

Thanks, Aaron! I really like your idea about making the triangle a style that can be applied  easily.

kirsten

Powered by Ploneboard
Document Actions