You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@etch.apache.org by "scott comer (JIRA)" <ji...@apache.org> on 2008/11/18 19:55:44 UTC

[jira] Created: (ETCH-14) Design and provide example of using forrest to deploy etch documentation

Design and provide example of using forrest to deploy etch documentation
------------------------------------------------------------------------

                 Key: ETCH-14
                 URL: https://issues.apache.org/jira/browse/ETCH-14
             Project: Etch
          Issue Type: New Feature
            Reporter: scott comer
             Fix For: 1.0.2


currently etch documentation is static wiki pages. we want to have etch documentation site built from sources in the svn repo, so that

1) etch documentation is versioned by release
2) current documentation is available as part of distribution (or perhaps, optional with dist).
3) apache forrest is used to generate said documentation as part of the build process in a variety of formats and distribution modes (pdf, html, wiki, whatever).

this item is about setting up the mechanisms and an example doc to accomplish this. follow on projects will actually convert other etch documents to use the same mechanism. the example doc can be anything, but a reasonable choice is the java binding user's guide or the compiler user's guide.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (ETCH-14) Design and provide example of using forrest to deploy etch documentation

Posted by "scott comer (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/ETCH-14?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

scott comer updated ETCH-14:
----------------------------

    Component/s: documentation
                 distribution
                 build

> Design and provide example of using forrest to deploy etch documentation
> ------------------------------------------------------------------------
>
>                 Key: ETCH-14
>                 URL: https://issues.apache.org/jira/browse/ETCH-14
>             Project: Etch
>          Issue Type: New Feature
>          Components: build, distribution, documentation
>            Reporter: scott comer
>             Fix For: 1.0.2
>
>
> currently etch documentation is static wiki pages. we want to have etch documentation site built from sources in the svn repo, so that
> 1) etch documentation is versioned by release
> 2) current documentation is available as part of distribution (or perhaps, optional with dist).
> 3) apache forrest is used to generate said documentation as part of the build process in a variety of formats and distribution modes (pdf, html, wiki, whatever).
> this item is about setting up the mechanisms and an example doc to accomplish this. follow on projects will actually convert other etch documents to use the same mechanism. the example doc can be anything, but a reasonable choice is the java binding user's guide or the compiler user's guide.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (ETCH-14) Design and provide example of using forrest to deploy etch documentation

Posted by "Gavin (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/ETCH-14?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12792462#action_12792462 ] 

Gavin commented on ETCH-14:
---------------------------

So, the idea here is to remove your cwiki stuff altogether and migrate the content to svn and have it all built in Forrest? If so, I can help set this up for you guys so please let me know.

> Design and provide example of using forrest to deploy etch documentation
> ------------------------------------------------------------------------
>
>                 Key: ETCH-14
>                 URL: https://issues.apache.org/jira/browse/ETCH-14
>             Project: Etch
>          Issue Type: New Feature
>          Components: build, distribution, documentation
>            Reporter: scott comer
>
> currently etch documentation is static wiki pages. we want to have etch documentation site built from sources in the svn repo, so that
> 1) etch documentation is versioned by release
> 2) current documentation is available as part of distribution (or perhaps, optional with dist).
> 3) apache forrest is used to generate said documentation as part of the build process in a variety of formats and distribution modes (pdf, html, wiki, whatever).
> this item is about setting up the mechanisms and an example doc to accomplish this. follow on projects will actually convert other etch documents to use the same mechanism. the example doc can be anything, but a reasonable choice is the java binding user's guide or the compiler user's guide.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (ETCH-14) Design and provide example of using forrest to deploy etch documentation

Posted by "scott comer (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/ETCH-14?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

scott comer updated ETCH-14:
----------------------------

    Fix Version/s:     (was: 1.0.2)

> Design and provide example of using forrest to deploy etch documentation
> ------------------------------------------------------------------------
>
>                 Key: ETCH-14
>                 URL: https://issues.apache.org/jira/browse/ETCH-14
>             Project: Etch
>          Issue Type: New Feature
>          Components: build, distribution, documentation
>            Reporter: scott comer
>
> currently etch documentation is static wiki pages. we want to have etch documentation site built from sources in the svn repo, so that
> 1) etch documentation is versioned by release
> 2) current documentation is available as part of distribution (or perhaps, optional with dist).
> 3) apache forrest is used to generate said documentation as part of the build process in a variety of formats and distribution modes (pdf, html, wiki, whatever).
> this item is about setting up the mechanisms and an example doc to accomplish this. follow on projects will actually convert other etch documents to use the same mechanism. the example doc can be anything, but a reasonable choice is the java binding user's guide or the compiler user's guide.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.