teo created CB-7369:
-----------------------
Summary: 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
Components: Docs
Environment: all
Reporter: teo
Priority: Critical
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.2#6252)
