You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@maven.apache.org by "Arik Kfir (JIRA)" <ji...@codehaus.org> on 2005/09/20 17:09:10 UTC

[jira] Created: (MNG-933) Ability to view how the site would look without generating the entire site

Ability to view how the site would look without generating the entire site
--------------------------------------------------------------------------

         Key: MNG-933
         URL: http://jira.codehaus.org/browse/MNG-933
     Project: Maven 2
        Type: New Feature
  Components: design  
 Reporter: Arik Kfir
    Priority: Minor


It would be nice to be able to run something like "m2 site:run" which would start a process that serves the site dynamically. If you know Apache Forrest, its similar to "forrest run" (as opposed to "forrest site" - which is like "m2 site:site").

The use case here, is that when writing documentation, it is frustrating to having to generate the entire site every time you make a change - if you simply want to preview the results. A better approach would be a Jetty (or Tomcat?) process that receives the request from a browser, and generates the content lazily. It would make writing m2-style docs a breeze.

In Maven 1 it would have been almost impossible, but with m2 - it might be possible.

The only caveat I see here is having to know what report to run against each URL. The only way I see to solve this is having reports expose (via annotations?) the list of files they generate, but that has disadvantages as well.

Non-the-less - this would be a killer helper plugin.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Updated: (MSITE-68) Ability to view how the site would look without generating the entire site

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MSITE-68?page=all ]

Brett Porter updated MSITE-68:
------------------------------

      Assign To: Brett Porter
    Fix Version: 2.0

John Casey has some sample code to do this, and it is fairly easy to do with jetty. I'll look into it.

> Ability to view how the site would look without generating the entire site
> --------------------------------------------------------------------------
>
>          Key: MSITE-68
>          URL: http://jira.codehaus.org/browse/MSITE-68
>      Project: Maven 2.x Site Plugin
>         Type: New Feature

>     Reporter: Arik Kfir
>     Assignee: Brett Porter
>     Priority: Trivial
>      Fix For: 2.0

>
>
> It would be nice to be able to run something like "m2 site:run" which would start a process that serves the site dynamically. If you know Apache Forrest, its similar to "forrest run" (as opposed to "forrest site" - which is like "m2 site:site").
> The use case here, is that when writing documentation, it is frustrating to having to generate the entire site every time you make a change - if you simply want to preview the results. A better approach would be a Jetty (or Tomcat?) process that receives the request from a browser, and generates the content lazily. It would make writing m2-style docs a breeze.
> In Maven 1 it would have been almost impossible, but with m2 - it might be possible.
> The only caveat I see here is having to know what report to run against each URL. The only way I see to solve this is having reports expose (via annotations?) the list of files they generate, but that has disadvantages as well.
> Non-the-less - this would be a killer helper plugin.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Updated: (MSITE-68) Ability to view how the site would look without generating the entire site

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MSITE-68?page=all ]

Brett Porter updated MSITE-68:
------------------------------

    Remaining Estimate: 3 hours
     Original Estimate: 3 hours

> Ability to view how the site would look without generating the entire site
> --------------------------------------------------------------------------
>
>          Key: MSITE-68
>          URL: http://jira.codehaus.org/browse/MSITE-68
>      Project: Maven 2.x Site Plugin
>         Type: New Feature

>     Reporter: Arik Kfir
>     Assignee: Brett Porter
>     Priority: Trivial
>      Fix For: 2.0

>
> Original Estimate: 3 hours
>         Remaining: 3 hours
>
> It would be nice to be able to run something like "m2 site:run" which would start a process that serves the site dynamically. If you know Apache Forrest, its similar to "forrest run" (as opposed to "forrest site" - which is like "m2 site:site").
> The use case here, is that when writing documentation, it is frustrating to having to generate the entire site every time you make a change - if you simply want to preview the results. A better approach would be a Jetty (or Tomcat?) process that receives the request from a browser, and generates the content lazily. It would make writing m2-style docs a breeze.
> In Maven 1 it would have been almost impossible, but with m2 - it might be possible.
> The only caveat I see here is having to know what report to run against each URL. The only way I see to solve this is having reports expose (via annotations?) the list of files they generate, but that has disadvantages as well.
> Non-the-less - this would be a killer helper plugin.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Updated: (MNG-933) Ability to view how the site would look without generating the entire site

Posted by "Jason van Zyl (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/MNG-933?page=all ]

Jason van Zyl updated MNG-933:
------------------------------

    Priority: Trivial  (was: Minor)

> Ability to view how the site would look without generating the entire site
> --------------------------------------------------------------------------
>
>          Key: MNG-933
>          URL: http://jira.codehaus.org/browse/MNG-933
>      Project: Maven 2
>         Type: New Feature

>   Components: design
>     Reporter: Arik Kfir
>     Priority: Trivial

>
>
> It would be nice to be able to run something like "m2 site:run" which would start a process that serves the site dynamically. If you know Apache Forrest, its similar to "forrest run" (as opposed to "forrest site" - which is like "m2 site:site").
> The use case here, is that when writing documentation, it is frustrating to having to generate the entire site every time you make a change - if you simply want to preview the results. A better approach would be a Jetty (or Tomcat?) process that receives the request from a browser, and generates the content lazily. It would make writing m2-style docs a breeze.
> In Maven 1 it would have been almost impossible, but with m2 - it might be possible.
> The only caveat I see here is having to know what report to run against each URL. The only way I see to solve this is having reports expose (via annotations?) the list of files they generate, but that has disadvantages as well.
> Non-the-less - this would be a killer helper plugin.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MSITE-68) Ability to view how the site would look without generating the entire site

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MSITE-68?page=comments#action_56724 ] 

Brett Porter commented on MSITE-68:
-----------------------------------

will probably just do the site for now, and later create a separate issue for reports

> Ability to view how the site would look without generating the entire site
> --------------------------------------------------------------------------
>
>          Key: MSITE-68
>          URL: http://jira.codehaus.org/browse/MSITE-68
>      Project: Maven 2.x Site Plugin
>         Type: New Feature

>     Reporter: Arik Kfir
>     Assignee: Brett Porter
>     Priority: Trivial
>      Fix For: 2.0

>
>
> It would be nice to be able to run something like "m2 site:run" which would start a process that serves the site dynamically. If you know Apache Forrest, its similar to "forrest run" (as opposed to "forrest site" - which is like "m2 site:site").
> The use case here, is that when writing documentation, it is frustrating to having to generate the entire site every time you make a change - if you simply want to preview the results. A better approach would be a Jetty (or Tomcat?) process that receives the request from a browser, and generates the content lazily. It would make writing m2-style docs a breeze.
> In Maven 1 it would have been almost impossible, but with m2 - it might be possible.
> The only caveat I see here is having to know what report to run against each URL. The only way I see to solve this is having reports expose (via annotations?) the list of files they generate, but that has disadvantages as well.
> Non-the-less - this would be a killer helper plugin.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org


[jira] Commented: (MSITE-68) Ability to view how the site would look without generating the entire site

Posted by "Brett Porter (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/MSITE-68?page=comments#action_56698 ] 

Brett Porter commented on MSITE-68:
-----------------------------------

there are two alternatives for how to implement this:
- run a jetty instance and deploy a servlet. This is similar to John's approach though the code is no longer relevant to the API/modules/etc
- simply start a monitoring process on files and then use the regular site generation on files as they change

I think the first is more beneficial as we can introduce the location of other modules in a reactor/USD to also solve the problems presented in the other JIRA issue about being able to see the entire hierachy in its desired layout.

> Ability to view how the site would look without generating the entire site
> --------------------------------------------------------------------------
>
>          Key: MSITE-68
>          URL: http://jira.codehaus.org/browse/MSITE-68
>      Project: Maven 2.x Site Plugin
>         Type: New Feature

>     Reporter: Arik Kfir
>     Assignee: Brett Porter
>     Priority: Trivial
>      Fix For: 2.0

>
>
> It would be nice to be able to run something like "m2 site:run" which would start a process that serves the site dynamically. If you know Apache Forrest, its similar to "forrest run" (as opposed to "forrest site" - which is like "m2 site:site").
> The use case here, is that when writing documentation, it is frustrating to having to generate the entire site every time you make a change - if you simply want to preview the results. A better approach would be a Jetty (or Tomcat?) process that receives the request from a browser, and generates the content lazily. It would make writing m2-style docs a breeze.
> In Maven 1 it would have been almost impossible, but with m2 - it might be possible.
> The only caveat I see here is having to know what report to run against each URL. The only way I see to solve this is having reports expose (via annotations?) the list of files they generate, but that has disadvantages as well.
> Non-the-less - this would be a killer helper plugin.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
   http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see:
   http://www.atlassian.com/software/jira


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@maven.apache.org
For additional commands, e-mail: dev-help@maven.apache.org