[jira] [Commented] (CB-13944) Why isn't the "platforms" documentation not the README of the platform repositories and pulled into the docs?

2018-03-06 Thread Jan Piotrowski (Sujan) (JIRA)

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

Jan Piotrowski (Sujan) commented on CB-13944:
-

The big advantage of having it with the actual code would of course be to 
increase the probability that with releases the docs would also be updated, not 
after the fact as it is mostly right now (or not updated at all).

> Why isn't the "platforms" documentation not the README of the platform 
> repositories and pulled into the docs?
> -
>
> Key: CB-13944
> URL: https://issues.apache.org/jira/browse/CB-13944
> Project: Apache Cordova
>  Issue Type: Improvement
>  Components: cordova-docs
>Reporter: Jan Piotrowski (Sujan)
>Priority: Major
>
> The version of the platform that is installed is hard coded in the CLI. 
> Wouldn't it make sense to move the "platform" documentation to the README of 
> the platform itself and only pull in this file (like the docs already do with 
> plugins) so there is some connection to the actual version?



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org



[jira] [Commented] (CB-13944) Why isn't the "platforms" documentation not the README of the platform repositories and pulled into the docs?

2018-03-05 Thread Dmitry Blotsky (JIRA)

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

Dmitry Blotsky commented on CB-13944:
-

[~Sujan12] yep, it would be a challenge. I think both approaches are roughly 
equally ok: putting it in a README, or just keeping it separate (like it is 
right now).

> Why isn't the "platforms" documentation not the README of the platform 
> repositories and pulled into the docs?
> -
>
> Key: CB-13944
> URL: https://issues.apache.org/jira/browse/CB-13944
> Project: Apache Cordova
>  Issue Type: Improvement
>  Components: cordova-docs
>Reporter: Jan Piotrowski (Sujan)
>Priority: Major
>
> The version of the platform that is installed is hard coded in the CLI. 
> Wouldn't it make sense to move the "platform" documentation to the README of 
> the platform itself and only pull in this file (like the docs already do with 
> plugins) so there is some connection to the actual version?



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org



[jira] [Commented] (CB-13944) Why isn't the "platforms" documentation not the README of the platform repositories and pulled into the docs?

2018-03-02 Thread Jan Piotrowski (Sujan) (JIRA)

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

Jan Piotrowski (Sujan) commented on CB-13944:
-

Changed.

One challenge would be to collect all platform information (some may have more 
than one page currently), and merge it with the current README.

> Why isn't the "platforms" documentation not the README of the platform 
> repositories and pulled into the docs?
> -
>
> Key: CB-13944
> URL: https://issues.apache.org/jira/browse/CB-13944
> Project: Apache Cordova
>  Issue Type: Improvement
>  Components: cordova-docs
>Reporter: Jan Piotrowski (Sujan)
>Priority: Major
>
> The version of the platform that is installed is hard coded in the CLI. 
> Wouldn't it make sense to move the "platform" documentation to the README of 
> the platform itself and only pull in this file (like the docs already do with 
> plugins) so there is some connection to the actual version?



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org



[jira] [Commented] (CB-13944) Why isn't the "platforms" documentation not the README of the platform repositories and pulled into the docs?

2018-03-02 Thread Dmitry Blotsky (JIRA)

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

Dmitry Blotsky commented on CB-13944:
-

This sounds like a good idea. I'd say it's not a Bug though. This is more like 
an Improvement.

> Why isn't the "platforms" documentation not the README of the platform 
> repositories and pulled into the docs?
> -
>
> Key: CB-13944
> URL: https://issues.apache.org/jira/browse/CB-13944
> Project: Apache Cordova
>  Issue Type: Bug
>  Components: cordova-docs
>Reporter: Jan Piotrowski (Sujan)
>Priority: Major
>
> The version of the platform that is installed is hard coded in the CLI. 
> Wouldn't it make sense to move the "platform" documentation to the README of 
> the platform itself and only pull in this file (like the docs already do with 
> plugins) so there is some connection to the actual version?



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

-
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org