You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@karaf.apache.org by "Andreas Pieber (Created) (JIRA)" <ji...@apache.org> on 2011/12/02 14:49:40 UTC

[jira] [Created] (KARAF-1078) Restructure linking to documentation

Restructure linking to documentation
------------------------------------

                 Key: KARAF-1078
                 URL: https://issues.apache.org/jira/browse/KARAF-1078
             Project: Karaf
          Issue Type: Improvement
          Components: website
            Reporter: Andreas Pieber


Jamie, Christian and I (Andreas) had a longer discussion in IRC how we think it's best to structure the documentation-website relationship. It could be nailed down to the following points:

# Have a static link from the website to (always) the latest documentation (e.g. http://karaf.apache.org/manual/latest/users-guide/index.html)
# linking from the main page to a page containing a link to all the specific docs; e.g. http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html http://karaf.apache.org/manual/latest-2.3.x/users-guide/index.html, ...
# never delete the manuals, even if we have http://karaf.apache.org/manual/latest-9.18.x/users-guide/index.html :-)

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (KARAF-1078) Restructure linking to documentation

Posted by "Andreas Pieber (Updated) (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/KARAF-1078?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Andreas Pieber updated KARAF-1078:
----------------------------------

    Description: 
Jamie, Christian and I (Andreas) had a longer discussion in IRC how we think it's best to structure the documentation-website relationship. It could be nailed down to the following points:

# Have a static link from the website to (always) the latest documentation (e.g. http://karaf.apache.org/manual/latest/users-guide/index.html)
# linking from the main page to a page containing a link to all the specific docs; e.g. http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html http://karaf.apache.org/manual/latest-2.3.x/users-guide/index.html, ...
# never delete the manuals, even if we have http://karaf.apache.org/manual/latest-9.18.x/users-guide/index.html :-)
# link to the specific documentations from the release pages of each release

  was:
Jamie, Christian and I (Andreas) had a longer discussion in IRC how we think it's best to structure the documentation-website relationship. It could be nailed down to the following points:

# Have a static link from the website to (always) the latest documentation (e.g. http://karaf.apache.org/manual/latest/users-guide/index.html)
# linking from the main page to a page containing a link to all the specific docs; e.g. http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html http://karaf.apache.org/manual/latest-2.3.x/users-guide/index.html, ...
# never delete the manuals, even if we have http://karaf.apache.org/manual/latest-9.18.x/users-guide/index.html :-)

    
> Restructure linking to documentation
> ------------------------------------
>
>                 Key: KARAF-1078
>                 URL: https://issues.apache.org/jira/browse/KARAF-1078
>             Project: Karaf
>          Issue Type: Improvement
>          Components: website
>            Reporter: Andreas Pieber
>
> Jamie, Christian and I (Andreas) had a longer discussion in IRC how we think it's best to structure the documentation-website relationship. It could be nailed down to the following points:
> # Have a static link from the website to (always) the latest documentation (e.g. http://karaf.apache.org/manual/latest/users-guide/index.html)
> # linking from the main page to a page containing a link to all the specific docs; e.g. http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html http://karaf.apache.org/manual/latest-2.3.x/users-guide/index.html, ...
> # never delete the manuals, even if we have http://karaf.apache.org/manual/latest-9.18.x/users-guide/index.html :-)
> # link to the specific documentations from the release pages of each release

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Resolved] (KARAF-1078) Restructure linking to documentation

Posted by "Jean-Baptiste Onofré (Resolved JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/KARAF-1078?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jean-Baptiste Onofré resolved KARAF-1078.
-----------------------------------------

    Resolution: Fixed

Revision 1226078 (and deployed on people.apache.org)
                
> Restructure linking to documentation
> ------------------------------------
>
>                 Key: KARAF-1078
>                 URL: https://issues.apache.org/jira/browse/KARAF-1078
>             Project: Karaf
>          Issue Type: Improvement
>          Components: website
>            Reporter: Andreas Pieber
>            Assignee: Jean-Baptiste Onofré
>
> Jamie, Christian and I (Andreas) had a longer discussion in IRC how we think it's best to structure the documentation-website relationship. It could be nailed down to the following points:
> # Have a static link from the website to (always) the latest documentation (e.g. http://karaf.apache.org/manual/latest/users-guide/index.html)
> # linking from the main page to a page containing a link to all the specific docs; e.g. http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html http://karaf.apache.org/manual/latest-2.3.x/users-guide/index.html, ...
> # never delete the manuals, even if we have http://karaf.apache.org/manual/latest-9.18.x/users-guide/index.html :-)
> # link to the specific documentations from the release pages of each release

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

[jira] [Commented] (KARAF-1078) Restructure linking to documentation

Posted by "Jean-Baptiste Onofré (Commented JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/KARAF-1078?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13177578#comment-13177578 ] 

Jean-Baptiste Onofré commented on KARAF-1078:
---------------------------------------------

As Dan mentioned on the user mailing list, a specific link should be present for "Karaf Manual".
                
> Restructure linking to documentation
> ------------------------------------
>
>                 Key: KARAF-1078
>                 URL: https://issues.apache.org/jira/browse/KARAF-1078
>             Project: Karaf
>          Issue Type: Improvement
>          Components: website
>            Reporter: Andreas Pieber
>            Assignee: Jean-Baptiste Onofré
>
> Jamie, Christian and I (Andreas) had a longer discussion in IRC how we think it's best to structure the documentation-website relationship. It could be nailed down to the following points:
> # Have a static link from the website to (always) the latest documentation (e.g. http://karaf.apache.org/manual/latest/users-guide/index.html)
> # linking from the main page to a page containing a link to all the specific docs; e.g. http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html http://karaf.apache.org/manual/latest-2.3.x/users-guide/index.html, ...
> # never delete the manuals, even if we have http://karaf.apache.org/manual/latest-9.18.x/users-guide/index.html :-)
> # link to the specific documentations from the release pages of each release

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

[jira] [Work started] (KARAF-1078) Restructure linking to documentation

Posted by "Jean-Baptiste Onofré (Work started JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/KARAF-1078?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Work on KARAF-1078 started by Jean-Baptiste Onofré.

> Restructure linking to documentation
> ------------------------------------
>
>                 Key: KARAF-1078
>                 URL: https://issues.apache.org/jira/browse/KARAF-1078
>             Project: Karaf
>          Issue Type: Improvement
>          Components: website
>            Reporter: Andreas Pieber
>            Assignee: Jean-Baptiste Onofré
>
> Jamie, Christian and I (Andreas) had a longer discussion in IRC how we think it's best to structure the documentation-website relationship. It could be nailed down to the following points:
> # Have a static link from the website to (always) the latest documentation (e.g. http://karaf.apache.org/manual/latest/users-guide/index.html)
> # linking from the main page to a page containing a link to all the specific docs; e.g. http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html http://karaf.apache.org/manual/latest-2.3.x/users-guide/index.html, ...
> # never delete the manuals, even if we have http://karaf.apache.org/manual/latest-9.18.x/users-guide/index.html :-)
> # link to the specific documentations from the release pages of each release

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

[jira] [Assigned] (KARAF-1078) Restructure linking to documentation

Posted by "Jean-Baptiste Onofré (Assigned JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/KARAF-1078?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jean-Baptiste Onofré reassigned KARAF-1078:
-------------------------------------------

    Assignee: Jean-Baptiste Onofré
    
> Restructure linking to documentation
> ------------------------------------
>
>                 Key: KARAF-1078
>                 URL: https://issues.apache.org/jira/browse/KARAF-1078
>             Project: Karaf
>          Issue Type: Improvement
>          Components: website
>            Reporter: Andreas Pieber
>            Assignee: Jean-Baptiste Onofré
>
> Jamie, Christian and I (Andreas) had a longer discussion in IRC how we think it's best to structure the documentation-website relationship. It could be nailed down to the following points:
> # Have a static link from the website to (always) the latest documentation (e.g. http://karaf.apache.org/manual/latest/users-guide/index.html)
> # linking from the main page to a page containing a link to all the specific docs; e.g. http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html http://karaf.apache.org/manual/latest-2.3.x/users-guide/index.html, ...
> # never delete the manuals, even if we have http://karaf.apache.org/manual/latest-9.18.x/users-guide/index.html :-)
> # link to the specific documentations from the release pages of each release

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

       

[jira] [Commented] (KARAF-1078) Restructure linking to documentation

Posted by "Jean-Baptiste Onofré (Commented JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/KARAF-1078?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13161659#comment-13161659 ] 

Jean-Baptiste Onofré commented on KARAF-1078:
---------------------------------------------

It sounds good.

Regarding 1, it's already more or less the case: if you click on Karaf HTML documentation, you go to:
http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html
                
> Restructure linking to documentation
> ------------------------------------
>
>                 Key: KARAF-1078
>                 URL: https://issues.apache.org/jira/browse/KARAF-1078
>             Project: Karaf
>          Issue Type: Improvement
>          Components: website
>            Reporter: Andreas Pieber
>            Assignee: Jean-Baptiste Onofré
>
> Jamie, Christian and I (Andreas) had a longer discussion in IRC how we think it's best to structure the documentation-website relationship. It could be nailed down to the following points:
> # Have a static link from the website to (always) the latest documentation (e.g. http://karaf.apache.org/manual/latest/users-guide/index.html)
> # linking from the main page to a page containing a link to all the specific docs; e.g. http://karaf.apache.org/manual/latest-2.2.x/users-guide/index.html http://karaf.apache.org/manual/latest-2.3.x/users-guide/index.html, ...
> # never delete the manuals, even if we have http://karaf.apache.org/manual/latest-9.18.x/users-guide/index.html :-)
> # link to the specific documentations from the release pages of each release

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira