cordova-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Filip Maj (JIRA)" <j...@apache.org>
Subject [jira] [Resolved] (CB-7369) Ridiculous link loop in documentation. Getting started is a headache
Date Fri, 14 Jul 2017 19:53:00 GMT

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

Filip Maj resolved CB-7369.
---------------------------
    Resolution: Not A Problem

It's been a while, and the structure of the guides has changed. I think it is much clearer
now.

> Ridiculous link loop in documentation. Getting started is a headache
> --------------------------------------------------------------------
>
>                 Key: CB-7369
>                 URL: https://issues.apache.org/jira/browse/CB-7369
>             Project: Apache Cordova
>          Issue Type: Bug
>         Environment: all
>            Reporter: teo
>            Priority: Minor
>
> I approach Cordova as a newcomer and look for a "getting started" kind of guide.
> So I start at http://cordova.apache.org/ and I notice a link to documentation, which
allegedly "includes Getting Started guides":
> http://cordova.apache.org/docs/en/3.5.0/
> Here I look for the words "Getting Started" and find nothing, but there's an promising
"Overview"  which reads:
> "START HERE if you are new to Cordova. Includes installation and next steps." (emphasys
added)
> So I follow that link:
> http://cordova.apache.org/docs/en/3.5.0/guide_overview_index.md.html#Overview
> And at the bottom it says:
> """
> Installing Cordova
> The installation of Cordova will differ depending on the workflow above you choose:
> Cross-platform workflow: see The Command-Line Interface.
> Platform-centered workflow: see the Platform Guides.
> """
> I want to choose the "platform-centered workflow", so I follow the link to Platform Guides:
> http://cordova.apache.org/docs/en/3.5.0/guide_platforms_index.md.html#Platform%20Guides
> which says:
> """
> Platform Guides
> BEFORE developing for any of the platforms listed below, install cordova's command-line
interface (CLI). (For details, see The Command-Line Interface.)
> """
> (emphasys added). So I follow that link:
> http://cordova.apache.org/docs/en/3.5.0/guide_cli_index.md.html#The%20Command-Line%20Interface
> And it says:
> """
> PREREQUISITES
> BEFORE running any command-line tools, you need to install SDKs for each platform you
wish to target. (See the Platform Guides for more details.)
> """
> which links back to the platform guides.
> LOOP DETECTED!
> There needs to be a clearer step-by-step installation guide (one for each platform or
workflow, if needed), without a loop of prerequisites where installing A is required before
you install B, but installing B is required before you install A.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

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


Mime
View raw message