cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mike Billau (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (CB-2619) Notify User When Viewing Outdated Documentation
Date Wed, 16 Oct 2013 17:35:51 GMT

    [ https://issues.apache.org/jira/browse/CB-2619?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13797034#comment-13797034
] 

Mike Billau commented on CB-2619:
---------------------------------

I'm pretty interested in seeing this come to fruition and would like to help. Any word on
when the doc generator is going to be rewritten? 

Based on the ML discussion and thinking about it, seems like the possible solutions are:
1. Create a /latest/ folder for the documentation, for every release we copy the current stable
docs into /latest/ and copy /latest/ into /n-1/, then just always use and direct people to
docs.cordova.io/latest/ 
2. Could we use a .htaccess file to map any requests to /latest/ to whatever the current latest
version is?  - this requires storing the latest version somewhere
3. Just inspect the URL with .js and if it's not latest, pop up the warning - this requires
storing the latest version somewhere
4. In all cases, inspect the referrer and if it is the docs server, don't pop up the warning
(since that implies that the user selected an outdated doc version) 

> Notify User When Viewing Outdated Documentation
> -----------------------------------------------
>
>                 Key: CB-2619
>                 URL: https://issues.apache.org/jira/browse/CB-2619
>             Project: Apache Cordova
>          Issue Type: Improvement
>          Components: Docs
>    Affects Versions: 2.6.0
>            Reporter: Michael Brooks
>            Assignee: Michael Brooks
>
> Search engines often return pages that are outdated versions of the searched API.
> We can help the user recognize that they are viewing outdated documentation by display
a flash message at the top (think Google Mail's undo message).
> We can display this message by using JavaScript to inspect the referrer. If it is external
to the documentation site, then display the message.
> [Reference Mailing-List thread|http://mail-archives.apache.org/mod_mbox/cordova-dev/201303.mbox/%3CCAEeF2Ted9UA1Vw_5nt%3Dn1dy39e1PvTtSGPExeWq8wo%2BQRQcgPw%40mail.gmail.com%3E]



--
This message was sent by Atlassian JIRA
(v6.1#6144)

Mime
View raw message