[jira] Created: (SANDBOX-266) Provide an introductory level documentation

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

[jira] Created: (SANDBOX-266) Provide an introductory level documentation

ASF GitHub Bot (Jira)
Provide an introductory level documentation
-------------------------------------------

                 Key: SANDBOX-266
                 URL: https://issues.apache.org/jira/browse/SANDBOX-266
             Project: Commons Sandbox
          Issue Type: Improvement
          Components: Pipeline
            Reporter: Ken Tanaka
            Priority: Minor


More information about the pipeline concepts and usage is needed. Some tutorial information covering basic usage to get new users started is needed.

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

Reply | Threaded
Open this post in threaded view
|

[jira] Updated: (SANDBOX-266) Provide an introductory level documentation

ASF GitHub Bot (Jira)

     [ https://issues.apache.org/jira/browse/SANDBOX-266?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Ken Tanaka updated SANDBOX-266:
-------------------------------

    Attachment: site.xml
                newDocs.tgz

New documentation to hook into the project documentation in pipeline/trunk/src/site

> Provide an introductory level documentation
> -------------------------------------------
>
>                 Key: SANDBOX-266
>                 URL: https://issues.apache.org/jira/browse/SANDBOX-266
>             Project: Commons Sandbox
>          Issue Type: Improvement
>          Components: Pipeline
>            Reporter: Ken Tanaka
>            Priority: Minor
>         Attachments: newDocs.tgz, site.xml
>
>   Original Estimate: 168h
>  Remaining Estimate: 168h
>
> More information about the pipeline concepts and usage is needed. Some tutorial information covering basic usage to get new users started is needed.

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

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (SANDBOX-266) Provide an introductory level documentation

ASF GitHub Bot (Jira)
In reply to this post by ASF GitHub Bot (Jira)

    [ https://issues.apache.org/jira/browse/SANDBOX-266?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12637621#action_12637621 ]

Ken Tanaka commented on SANDBOX-266:
------------------------------------

A preview of this documentation has been posted here https://www.ngdc.noaa.gov/wiki/index.php?title=PipelineBasics

> Provide an introductory level documentation
> -------------------------------------------
>
>                 Key: SANDBOX-266
>                 URL: https://issues.apache.org/jira/browse/SANDBOX-266
>             Project: Commons Sandbox
>          Issue Type: Improvement
>          Components: Pipeline
>            Reporter: Ken Tanaka
>            Priority: Minor
>         Attachments: newDocs.tgz, site.xml
>
>   Original Estimate: 168h
>  Remaining Estimate: 168h
>
> More information about the pipeline concepts and usage is needed. Some tutorial information covering basic usage to get new users started is needed.

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

Reply | Threaded
Open this post in threaded view
|

[jira] Resolved: (SANDBOX-266) Provide an introductory level documentation

ASF GitHub Bot (Jira)
In reply to this post by ASF GitHub Bot (Jira)

     [ https://issues.apache.org/jira/browse/SANDBOX-266?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Rahul Akolkar resolved SANDBOX-266.
-----------------------------------

    Resolution: Fixed

Thanks, this is great, I've committed the new tutorial in r704282:

  http://svn.apache.org/viewvc?view=rev&revision=704282

I made some minor changes such as adding the missing license header to the tutorial source, adding a .txt extension to the README and removing some of the outdated "Jakarta" references in text and links.

I have also published the latest website, so the new tutorial will become available here when the next sync happens (in a couple of hours):

  http://commons.apache.org/sandbox/pipeline/pipeline_basics.html

To update the tutorial further at any point (or any other pipeline code), please open another ticket in JIRA. For any future patches or updates, please use the latest SVN artifacts as a starting point (I noticed you had an older version of site.xml attached here, for instance, which I ended up manually merging).


> Provide an introductory level documentation
> -------------------------------------------
>
>                 Key: SANDBOX-266
>                 URL: https://issues.apache.org/jira/browse/SANDBOX-266
>             Project: Commons Sandbox
>          Issue Type: Improvement
>          Components: Pipeline
>            Reporter: Ken Tanaka
>            Priority: Minor
>         Attachments: newDocs.tgz, site.xml
>
>   Original Estimate: 168h
>  Remaining Estimate: 168h
>
> More information about the pipeline concepts and usage is needed. Some tutorial information covering basic usage to get new users started is needed.

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