[jira] [Updated] (CB-7226) Update Documentation for Independent releases

["Steve Gill (JIRA)" <ji...@apache.org>]

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

Steve Gill updated CB-7226:
---------------------------

    Description: 
Cordova-docs:
 - Most of the docs are not actually affected by platform versions.
 - Mainly though, it's the platform guides that are.
 - Three options:

Option 1
Set default version to "edge" & always annotate with "added in X.X.X, removed in X.X.X"

Option 2
Move guides to live in platform repos and link to them from docs.

Option 3
- Docs get same version as CLI & get tagged alongside cli releases
- We can still annotate with "added in X.X.X, removed in X.X.X" where it makes sense. (like the upgrade guides)
- Point docs.cordova.io to edge
- Dropdown will show tagged versions
Pros:
- Keeps a public history of older docs at a point in time. Easy to use for people who don't want the latest
- Gives us flexibility in changing docs and not worrying about older versions. 

Earlier proposal can be found at https://docs.google.com/document/d/1qwpypH7sH0wH9Sbesmg8JZow-l8IqdZtF1BtLUZb1As/edit. Will need to be updated

  was:
Cordova-docs:
 - Most of the docs are not actually affected by platform versions.
 - Mainly though, it's the platform guides that are.
 - Two options that I see:
   - 1) Set default version to "edge" & always annotate with "added in
X.X.X, removed in X.X.X"
   - 2) Move guides to live in platform repos and link to them from docs.


> Update Documentation for Independent releases
> ---------------------------------------------
>
>                 Key: CB-7226
>                 URL: https://issues.apache.org/jira/browse/CB-7226
>             Project: Apache Cordova
>          Issue Type: Sub-task
>          Components: Docs
>            Reporter: Steve Gill
>
> Cordova-docs:
>  - Most of the docs are not actually affected by platform versions.
>  - Mainly though, it's the platform guides that are.
>  - Three options:
> Option 1
> Set default version to "edge" & always annotate with "added in X.X.X, removed in X.X.X"
> Option 2
> Move guides to live in platform repos and link to them from docs.
> Option 3
> - Docs get same version as CLI & get tagged alongside cli releases
> - We can still annotate with "added in X.X.X, removed in X.X.X" where it makes sense. (like the upgrade guides)
> - Point docs.cordova.io to edge
> - Dropdown will show tagged versions
> Pros:
> - Keeps a public history of older docs at a point in time. Easy to use for people who don't want the latest
> - Gives us flexibility in changing docs and not worrying about older versions. 
> Earlier proposal can be found at https://docs.google.com/document/d/1qwpypH7sH0wH9Sbesmg8JZow-l8IqdZtF1BtLUZb1As/edit. Will need to be updated



--
This message was sent by Atlassian JIRA
(v6.2#6252)