cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Brooks (JIRA)" <j...@apache.org>
Subject [jira] [Created] (CB-3192) Update Edge Docs to Reference Version with x.x.x
Date Fri, 19 Apr 2013 17:41:15 GMT
Michael Brooks created CB-3192:
----------------------------------

             Summary: Update Edge Docs to Reference Version with x.x.x
                 Key: CB-3192
                 URL: https://issues.apache.org/jira/browse/CB-3192
             Project: Apache Cordova
          Issue Type: Bug
          Components: Docs
    Affects Versions: 2.7.0
            Reporter: Michael Brooks
            Assignee: Michael Brooks
             Fix For: 2.7.0


Currently, the edge documentation uses the version number of the upcoming release. For example,
{{cordova-2.7.0.js}} or "Getting Started with 2.7.0".

There are a few problems with this approach. First, it assumes the version number of the upcoming
release. Second, there are situations in the guides where we need to reference a specific
version, such as "Updating from 2.6.0 to 2.7.0."

Currently, the documentation generator will update all version number to the latest release.
This sometimes conflicts with guides that do not want to auto-increment the version number.

The solution is to reference the "next version" as "x.x.x". For example: 

* {{cordova-x.x.x.js}} will become {{cordova-2.7.0.js}} in the next release.
* "Getting Started with x.x.x" will become "Getting Started with 2.7.0" in the next release.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message