multiple bad links in arrow_cookbook/arrow_FAQ.rst

[dmitris]

There are several bad links in the FAQ https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_FAQs.rst:

1) "here" in "Linux box has arrow installed and it has all the packages listed here" points to http://devel-stage.corp.yahoo.com/ynodejs_arrow/guide/arrow_getting_started.html#linux-installation which is a Yahoo internal URL and is not reachable from outside Internet.

2) same in the next sentence - "selenium server" points to http://devel-stage.corp.yahoo.com/ynodejs_arrow/guide/arrow_getting_started.html#selenium-server

3) in https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_FAQs.rst#how-do-i-point-arrow-to-a-specific-selenium-server, "config file's" link in "Update the config file's seleniumHost value" goes to 404 page https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.html#configuration

4) In https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_FAQs.rst#error-arrowserver---buffer-65-78-65, "installed PhantomJS" link goes to a 404 page https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.html#mac-installation

5) In https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_FAQs.rst#how-can-i-use-the-locator-controller-to-login, "locator" link in "Built-in, Arrow comes with two controllers, default and locator" goes to a 404 page https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.html#the-locator-controller

6) In https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_FAQs.rst#how-can-i-install-a-specific-arrow-version "arrow@0.0.43" in "sudo npm install --registry=http:// arrow@0.0.43 -g" becomes a mailto link which opens a mail client when clicked - will be confusing to users.

(there are also a couple of "TODO... needs to be updated" notes on that page)

[dmitris]

There are more bad links in other Cookbook documents, need to be double-checked and fixed:

https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_CI.rst https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_extending.rst https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.rst https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst

There are also non-functional relative links: For example, in the "Getting started" document, the "Mac" links points to https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#mac but the section's anchor is https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#mac-installation

Same with "Unit, Functional and Integration" links on https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst

[klamping]

Pull request added for the first five links. https://github.com/yahoo/arrow/pull/32

I'll send more requests as I update the rest of the links.

[dmitris]

On https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst, the relative links need to be fixed - instead of https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#unit, https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#functional and https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#integration the links should point to: https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#unit-tests https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#functional-tests https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst#integration-tests

There are also broken images in the middle of the page under "Functional tests" and "TODO... needs to be updated" comments.

[dmitris]

Similarly, on https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst, all the "Verification" relative links are wrong - they point to a no-op https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#verification instead of https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#verifying-the-installation

[dmitris]

Submitted https://github.com/yahoo/arrow/pull/41 - but there's something strange about the way GitHub treats the internal link markup which differs from rst2html.py.

[proverma]

can we close this bug now ?

[dmitris]

FAQ seems OK but there is a bad link in https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_CI.rst - "dimensions file" points to 404 https://github.com/yahoo/arrow/blob/master/arrow_in-depth.rst#test-descriptor-parametrization-and-test-environments

There are also bad/non-functional relative links on https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_tutorial.rst ("Unit, Functional, and Integration")

On https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.rst, if you search for "Descriptors", the relative link to https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.rst#descriptors does not do anything (should be https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.rst#test-descriptors)

On the same page, https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_in-depth.rst, the "martini" shows as non-functional relative link in the sentence: directory name starts with a prefix like "martini"; (there is a commit comment "remove all the martini words" - should this one be gone as well?)

On https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst, "Verification" relative link in the phrase "Now you may proceed to Install Verification" is bad/non-functional - it points to https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#verification but should be https://github.com/yahoo/arrow/blob/master/docs/arrow_cookbook/arrow_getting_started.rst#verifying-the-installation