You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@struts.apache.org by "Tabrez Iqbal (JIRA)" <ji...@apache.org> on 2008/09/23 16:43:25 UTC

[jira] Created: (WW-2813) Documentation typo fixes

Documentation typo fixes
------------------------

                 Key: WW-2813
                 URL: https://issues.apache.org/struts/browse/WW-2813
             Project: Struts 2
          Issue Type: Improvement
          Components: Documentation
    Affects Versions: 2.0.11.2
            Reporter: Tabrez Iqbal
            Priority: Minor


How to submit documentation improvement suggestions like typo fixes etc.?

Look at this page: http://struts.apache.org/2.x/docs/guides.html

1. PreResultListener page(http://struts.apache.org/2.x/docs/preresultlistener.html) links to Localization page(http://struts.apache.org/2.x/docs/localization.html). I think if the order on the guide home page is followed, PreResultListener should link to Validation page(http://struts.apache.org/2.x/docs/validation.html). Validation page correctly links to Localization page.

2. How about a link to Formatting Dates and Numbers page(http://struts.apache.org/2.x/docs/formatting-dates-and-numbers.html) from the Localization page?

3. Type Conversion page(http://struts.apache.org/2.x/docs/type-conversion.html) links back to Interceptors page. Why? Shouldn't it link to "Portlets - Tutorial" page(http://struts.apache.org/2.x/docs/struts-2-portlet-tutorial.html) or to the FAQ page or to the Home page going by the structure on the guides home page?

I also came across a few typos when reading the printed copy of the documentation. Do I submit them here in the ticket or is there a web page somewhere explaining how to download the documentation in the source form, make changes and submit the patch? What is the preferred way?

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


[jira] Resolved: (WW-2813) Documentation typo fixes

Posted by "Musachy Barroso (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/struts/browse/WW-2813?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Musachy Barroso resolved WW-2813.
---------------------------------

    Resolution: Fixed

#1, and #3, I don't see any way to change that. #2 fixed. See this:

http://cwiki.apache.org/confluence/display/WW/Editing+the+Documentation

for details on how to get access to the wiki.

> Documentation typo fixes
> ------------------------
>
>                 Key: WW-2813
>                 URL: https://issues.apache.org/struts/browse/WW-2813
>             Project: Struts 2
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 2.0.11.2
>            Reporter: Tabrez Iqbal
>            Priority: Minor
>             Fix For: 2.1.3
>
>
> How to submit documentation improvement suggestions like typo fixes etc.?
> Look at this page: http://struts.apache.org/2.x/docs/guides.html
> 1. PreResultListener page(http://struts.apache.org/2.x/docs/preresultlistener.html) links to Localization page(http://struts.apache.org/2.x/docs/localization.html). I think if the order on the guide home page is followed, PreResultListener should link to Validation page(http://struts.apache.org/2.x/docs/validation.html). Validation page correctly links to Localization page.
> 2. How about a link to Formatting Dates and Numbers page(http://struts.apache.org/2.x/docs/formatting-dates-and-numbers.html) from the Localization page?
> 3. Type Conversion page(http://struts.apache.org/2.x/docs/type-conversion.html) links back to Interceptors page. Why? Shouldn't it link to "Portlets - Tutorial" page(http://struts.apache.org/2.x/docs/struts-2-portlet-tutorial.html) or to the FAQ page or to the Home page going by the structure on the guides home page?
> I also came across a few typos when reading the printed copy of the documentation. Do I submit them here in the ticket or is there a web page somewhere explaining how to download the documentation in the source form, make changes and submit the patch? What is the preferred way?

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


[jira] Commented: (WW-2813) Documentation typo fixes

Posted by "James Holmes (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/struts/browse/WW-2813?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=45140#action_45140 ] 

James Holmes commented on WW-2813:
----------------------------------

Yes, please submit typo fixes and patches for typos to us by opening Jira tickets like this.

Thanks for the help!

> Documentation typo fixes
> ------------------------
>
>                 Key: WW-2813
>                 URL: https://issues.apache.org/struts/browse/WW-2813
>             Project: Struts 2
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 2.0.11.2
>            Reporter: Tabrez Iqbal
>            Priority: Minor
>             Fix For: 2.1.3
>
>
> How to submit documentation improvement suggestions like typo fixes etc.?
> Look at this page: http://struts.apache.org/2.x/docs/guides.html
> 1. PreResultListener page(http://struts.apache.org/2.x/docs/preresultlistener.html) links to Localization page(http://struts.apache.org/2.x/docs/localization.html). I think if the order on the guide home page is followed, PreResultListener should link to Validation page(http://struts.apache.org/2.x/docs/validation.html). Validation page correctly links to Localization page.
> 2. How about a link to Formatting Dates and Numbers page(http://struts.apache.org/2.x/docs/formatting-dates-and-numbers.html) from the Localization page?
> 3. Type Conversion page(http://struts.apache.org/2.x/docs/type-conversion.html) links back to Interceptors page. Why? Shouldn't it link to "Portlets - Tutorial" page(http://struts.apache.org/2.x/docs/struts-2-portlet-tutorial.html) or to the FAQ page or to the Home page going by the structure on the guides home page?
> I also came across a few typos when reading the printed copy of the documentation. Do I submit them here in the ticket or is there a web page somewhere explaining how to download the documentation in the source form, make changes and submit the patch? What is the preferred way?

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


[jira] Updated: (WW-2813) Documentation typo fixes

Posted by "James Holmes (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/struts/browse/WW-2813?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

James Holmes updated WW-2813:
-----------------------------

    Fix Version/s: 2.1.3

> Documentation typo fixes
> ------------------------
>
>                 Key: WW-2813
>                 URL: https://issues.apache.org/struts/browse/WW-2813
>             Project: Struts 2
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 2.0.11.2
>            Reporter: Tabrez Iqbal
>            Priority: Minor
>             Fix For: 2.1.3
>
>
> How to submit documentation improvement suggestions like typo fixes etc.?
> Look at this page: http://struts.apache.org/2.x/docs/guides.html
> 1. PreResultListener page(http://struts.apache.org/2.x/docs/preresultlistener.html) links to Localization page(http://struts.apache.org/2.x/docs/localization.html). I think if the order on the guide home page is followed, PreResultListener should link to Validation page(http://struts.apache.org/2.x/docs/validation.html). Validation page correctly links to Localization page.
> 2. How about a link to Formatting Dates and Numbers page(http://struts.apache.org/2.x/docs/formatting-dates-and-numbers.html) from the Localization page?
> 3. Type Conversion page(http://struts.apache.org/2.x/docs/type-conversion.html) links back to Interceptors page. Why? Shouldn't it link to "Portlets - Tutorial" page(http://struts.apache.org/2.x/docs/struts-2-portlet-tutorial.html) or to the FAQ page or to the Home page going by the structure on the guides home page?
> I also came across a few typos when reading the printed copy of the documentation. Do I submit them here in the ticket or is there a web page somewhere explaining how to download the documentation in the source form, make changes and submit the patch? What is the preferred way?

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