[DISCUSS] New strcuture for documentation on Sling site
Hi all Okay, I scanned the whole docs now (took some time...) and would like to restructure things a little bit to make it more easy to find the right doc. Here's the old structure, all topics with a [DELETE] should be deleted, the others would be transfered to the new structure: OLD: x Documentation x Discover Sling in 15 minutes x Architecture x Getting and building Sling x JCR - How Sling uses and integrates with JCR (no content) x Resources x Request Parameters x Filters x Eventing and Jobs - Thread Handling (no content) [DELETE] x Advanced Topics x Logging [OK] [UPDATE] x Authentication x MIME Type Support x Configuration Support x Content Loading x Manipulating Content/SlingPostServlet x Internationalization Support x Installing and Upgrading Bundles - Assembly (can someone check, seems to be outdated) [DELETE] x Implementing a ResourceProvider (no content) - Using ScriptEngines from scripting.dev.java.net (no content) [DELETE] x Apache Sling Rewriter (Code under whiteboard) - Sling API (outdated) [DELETE] x Provisioning and Startup (outdated) - Object Content Mapping (no content) [DELETE] x Dispatching Requests (outdated) x Default Mapping and Rendering (outdated) x Development x Dependency Management x Getting and Building Sling x Documenting Sling x Repository Based Development x Bundles - How to create bundles and provide services and scripts (no content) - Integrating Scripting Languages (not much content) [DELETE] - Groovy Support [DELETE] x XSLT Processing Pipeline x Maven Tips Tricks x Maven Sling Plugin x Maven JspC Plugin x Sling 5 API [OK] In the new navigation everything is arranged in a hierachical structure under Documentation. My proposed new structure looks like this: NEW: - Documentation (Overview - was Documenting Sling [UPDATE]) - Getting started - What is Sling [NEW, extracts from existing home] - Discover Sling in 15 minutes [OK] - How Sling uses and integrates with JCR [NEW] - Engine, the heart of Sling - Architecture - Resources [UPDATE] - Request Parameters [OK] - Filters [OK] - Dispatching Requests [REWRITE] - Default Mapping and Rendering [REWRITE] - Eventing and Jobs [CHECK] -- Carsten can you have a look at it - Authentication [OK] - Development - Getting and building Sling [UPDATE] - Maven Tips Tricks [UPDATE] - Setup with Eclipse 3.4 [NEW, from Wiki] - Maven Sling Plugin [UPDATE, got content from Felix] - Maven JspC Plugin [CHECK] - How to create a new bundles and services for Sling [NEW] - Logging [OK] [UPDATE] - RequestProgressTracker [NEW, from SLING-3] - Dependency Management [OK] - Repository Based Development [OK] (lack of Eclipse Plugin) - Bundles - MIME Type Support (commons/mime) [OK] - Internationalization Support (extensions/i18n) [UPDATE] - Manipulating Content/SlingPostServlet (servlets/post) [OK] - Content Loading (lack of JSON/XML) (jcr/contentloader) [UPDATE] ... a doc page for each bundle should be the future ambition - Tutorials How-Tos - Launch Sling (was Provisioning and Startup) [REWRITE] - Installing and Upgrading Bundles [OK] -- link to [1] - ACL/ACE [NEW] - Default Sling JCR layout and nodetypes [NEW] - Implementing a ResourceProvider [NEW] - Apache Sling Rewriter [OK] (Code under whiteboard) - XSLT Processing Pipeline [OK] - Wiki - configuration (was Configuration Support) [OK] - Sling in production - Sling standalone [NEW] - Sling in a Servlet container [NEW] - Sling with Apache httpd [NEW] - Access Logging [NEW] - Sling API (JavaDoc) [OK] FAQ [DELETE] - should rather be integrated into the doc on the related themes. Next steps: * give me your input about the new structure and also missing topics * I begin to update the structure and content (and definitifely ask for help from the list for several topics) [1] http://felix.apache.org/site/apache-felix-web-console.html best regards mike
RE: Documentation Contributions
Hi Carl I'm working through creating some authentication handlers for a project (sakai project), so my first contributions will most like be in this area. If there are areas that you would like worked on, just let me know as I'm totally flexible on this. Sounds very good. It would appreciate it, if you can enhance the docs under Authentication [1]. If possible it would be very good if you can write also some docs about ACL/ACE, there's nothing about that by now. Just write docs to the wiki or send it to me and I would integrate it on the Sling site. You also can have a look at my last mail [2] about the new docs structure, if there's any topic marked with [NEW] or [REWRITE] or even [UPDATE] where you can contribute, I would appreciate it. [1] http://incubator.apache.org/sling/site/authentication.html [2] http://markmail.org/message/7vu63i7rketgdozi best regards mike
Re: Documentation Contributions
MIke, Please excuse the intrusion. Carl, There are is some doc on ACL,ACE I did a while back at [1] and [2], [3], [4] feel free to grab, shout if you want the sources for the diagrams. its OmniGraffle. (soo you probably wont :)) [2] would need cutting back to just Jackrabbit/Sling Warning on [4] its my notebook when I was evaluating Jackrabbits AuthZ implementation against previous implementations, so some may be wrong, and again you will need to cut whatever is there back to Jackrabbit/ Sling but others have found it helpful. If they are not useful then just ignore them :) Ian [1] http://groups.google.com/group/sakai-kernel/web/configuring-users-and-groups (towards the bottom) [2] http://sakai-kernel.googlegroups.com/web/DynamicACLs.png?gda=5ZKEDUEAAAC6JqF2TUgcYhor6C0puw6-wHt5qr7Ky8wR2CxS5Ktt6RH8uehpKFINyc3RpuJEHgRTCT_pCLcFTwcI3Sro5jAzlXFeCn-cdYleF-vtiGpWAA [3] http://sakai-kernel.googlegroups.com/web/JackrabbitAuthZ.png?gda=KdDg-kUAAAC6JqF2TUgcYhor6C0puw6-iO1FoRxLZLh40cWmzosj5-nyjkY-Jhfmky0EVK4dvbdzlqnWZQD3y6jZqCMfSFQ6Gu1iLHeqhw4ZZRj3RjJ_-A [4] http://groups.google.com/group/sakai-kernel/web/jsr-283-authz-mappings On 22 May 2009, at 10:18, Mike Müller wrote: Hi Carl I'm working through creating some authentication handlers for a project (sakai project), so my first contributions will most like be in this area. If there are areas that you would like worked on, just let me know as I'm totally flexible on this. Sounds very good. It would appreciate it, if you can enhance the docs under Authentication [1]. If possible it would be very good if you can write also some docs about ACL/ACE, there's nothing about that by now. Just write docs to the wiki or send it to me and I would integrate it on the Sling site. You also can have a look at my last mail [2] about the new docs structure, if there's any topic marked with [NEW] or [REWRITE] or even [UPDATE] where you can contribute, I would appreciate it. [1] http://incubator.apache.org/sling/site/authentication.html [2] http://markmail.org/message/7vu63i7rketgdozi best regards mike
RE: Documentation Contributions
Hi Ian, hi Carl MIke, Please excuse the intrusion. Carl, There are is some doc on ACL,ACE I did a while back at [1] and [2], [3], [4] feel free to grab, shout if you want the sources for the diagrams. its OmniGraffle. (soo you probably wont :)) [2] would need cutting back to just Jackrabbit/Sling Warning on [4] its my notebook when I was evaluating Jackrabbits AuthZ implementation against previous implementations, so some may be wrong, and again you will need to cut whatever is there back to Jackrabbit/ Sling but others have found it helpful. If they are not useful then just ignore them :) Ian [1] http://groups.google.com/group/sakai-kernel/web/configuring-us ers-and-groups (towards the bottom) [2] http://sakai-kernel.googlegroups.com/web/DynamicACLs.png?gda=5ZKEDUEAAAC6JqF2TUgcYhor6C0puw6-wHt5qr7Ky8wR2CxS5Ktt6RH8uehpKFINyc3RpuJEHgRTCT_pCLcFTwcI3Sro5jAzlXFeCn-cdYleF-vtiGpWAA [3] http://sakai-kernel.googlegroups.com/web/JackrabbitAuthZ.png?gda=KdDg-kUAAAC6JqF2TUgcYhor6C0puw6-iO1FoRxLZLh40cWmzosj5-nyjkY-Jhfmky0EVK4dvbdzlqnWZQD3y6jZqCMfSFQ6Gu1iLHeqhw4ZZRj3RjJ_-A [4] http://groups.google.com/group/sakai-kernel/web/jsr-283-authz-mappings That seems to be a lot of docs, thank you Ian for mentioning it. Carl, if you can cut these docs down to Sling things it would be very useful. Maybe even the sakai-K2 things could be used as an example how to make a custom implementation. best regards mike
Re: Sling Logo Issue
The small crack between the top of the S and the line connecting the S and g in the PNG version of the logo has always annoyed me. /Pontus Felix Meschberger wrote: Hi all, We have an issue with our beloved logo: The feather is the wrong way around... I have finally tried to fix this by taking the official feather SVN image from [1] and integrate it with our Sling test. I have committed the result as Sling_new.svg [2] and Sling_new.png [3]. Please comment ;-) Thanks and Regards Felix [1] http://apache.org/foundation/press/kit/feather.svg [2] http://svn.apache.org/repos/asf/incubator/sling/trunk/site/src/logo/Sling_new.svg [3] http://svn.apache.org/repos/asf/incubator/sling/trunk/site/src/logo/Sling_new.png
Re: Sling Logo Issue
On Fri, May 22, 2009 at 2:32 PM, Pontus Amberg pontus.amb...@milso.se wrote: The small crack between the top of the S and the line connecting the S and g in the PNG version of the logo has always annoyed me. Good catch - I didn't notice it before, but now it's in my face all the time ;-) Apart from that, changes look good, thanks Felix! -Bertrand
Re: [DISCUSS] New strcuture for documentation on Sling site
Hi, first of all, good to see progress on the documentation front! On Fri, May 22, 2009 at 4:08 AM, Mike Müller mike...@mysign.ch wrote: Manipulating Content/SlingPostServlet is a rather important topic for most everyday Sling development, so it should get a more prominent location (could also be done through a link from an overviewpage, though). Having it under its technically correct bundles parent page makes it a bit hard to find for new people who don't really know what they are looking for. This might apply to some other topics as well, so I wonder if there is a way to highlight them in any way. Regards, Alex -- Alexander Klimetschek alexander.klimetsc...@day.com
RE: [DISCUSS] New strcuture for documentation on Sling site
Hi Alex first of all, good to see progress on the documentation front! Manipulating Content/SlingPostServlet is a rather important topic for most everyday Sling development, so it should get a more prominent location (could also be done through a link from an overviewpage, though). Having it under its technically correct bundles parent page makes it a bit hard to find for new people who don't really know what they are looking for. This might apply to some other topics as well, so I wonder if there is a way to highlight them in any way. I see two ways to reach your point: Everything which belongs really to the core of Sling should go into Engine, the heart of Sling. So maybe Manipulating Content/SlingPostServlet should also go there (and have a Link under bundles). The second possibility could be to make two sections under bundles (eg. Core bundles and Extenstions). I prefer the second approach. We could link in the Overview/Engine section to the SlingPostServlet and some other important functionalities as in addition. Last but not least, the bundles section is a very important section (if it will be complete one time). best regards mike
Re: [DISCUSS] New strcuture for documentation on Sling site
I like the idea of an overview page (the new documentation parent page) with a hot topics or better Getting Started box with a roadmap of links the user can follow to get a good overview of Sling. This would allow to have a technically correct hierarchy, but supporting newcommers who have no clue how Sling is organized and where to start. WDYT? On Fri, May 22, 2009 at 3:43 PM, Mike Müller mike...@mysign.ch wrote: Hi Alex first of all, good to see progress on the documentation front! Manipulating Content/SlingPostServlet is a rather important topic for most everyday Sling development, so it should get a more prominent location (could also be done through a link from an overviewpage, though). Having it under its technically correct bundles parent page makes it a bit hard to find for new people who don't really know what they are looking for. This might apply to some other topics as well, so I wonder if there is a way to highlight them in any way. I see two ways to reach your point: Everything which belongs really to the core of Sling should go into Engine, the heart of Sling. So maybe Manipulating Content/SlingPostServlet should also go there (and have a Link under bundles). The second possibility could be to make two sections under bundles (eg. Core bundles and Extenstions). I prefer the second approach. We could link in the Overview/Engine section to the SlingPostServlet and some other important functionalities as in addition. Last but not least, the bundles section is a very important section (if it will be complete one time). best regards mike
Re: Sling Logo Issue
Hi Pontus, Pontus Amberg schrieb: The small crack between the top of the S and the line connecting the S and g in the PNG version of the logo has always annoyed me. Woa ! Never noticed that. Thanks for mentioning it. I have committed a fix to the SVG and a new PNG export. I think it is better now, right ? Regard Felix /Pontus Felix Meschberger wrote: Hi all, We have an issue with our beloved logo: The feather is the wrong way around... I have finally tried to fix this by taking the official feather SVN image from [1] and integrate it with our Sling test. I have committed the result as Sling_new.svg [2] and Sling_new.png [3]. Please comment ;-) Thanks and Regards Felix [1] http://apache.org/foundation/press/kit/feather.svg [2] http://svn.apache.org/repos/asf/incubator/sling/trunk/site/src/logo/Sling_new.svg [3] http://svn.apache.org/repos/asf/incubator/sling/trunk/site/src/logo/Sling_new.png
[jira] Created: (SLING-983) Add sling.properties file to configuration status page
Add sling.properties file to configuration status page -- Key: SLING-983 URL: https://issues.apache.org/jira/browse/SLING-983 Project: Sling Issue Type: Improvement Components: General Reporter: Felix Meschberger It would be good, if the sling.properties file could be provided through a Felix Web Console ConfigurationPrinter to include it into the Configuration Status output to ease support. Maybe this would be part of the Sling Engine bundle, which is the core engine of Sling. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online.
Re: Sling Logo Issue
Yup, it looks fine now. /Pontus Felix Meschberger wrote: Hi Pontus, Pontus Amberg schrieb: The small crack between the top of the S and the line connecting the S and g in the PNG version of the logo has always annoyed me. Woa ! Never noticed that. Thanks for mentioning it. I have committed a fix to the SVG and a new PNG export. I think it is better now, right ? Regard Felix /Pontus Felix Meschberger wrote: Hi all, We have an issue with our beloved logo: The feather is the wrong way around... I have finally tried to fix this by taking the official feather SVN image from [1] and integrate it with our Sling test. I have committed the result as Sling_new.svg [2] and Sling_new.png [3]. Please comment ;-) Thanks and Regards Felix [1] http://apache.org/foundation/press/kit/feather.svg [2] http://svn.apache.org/repos/asf/incubator/sling/trunk/site/src/logo/Sling_new.svg [3] http://svn.apache.org/repos/asf/incubator/sling/trunk/site/src/logo/Sling_new.png
