Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

multiple bad links in arrow_cookbook/arrow_FAQ.rst #30

Closed
dmitris opened this Issue Nov 21, 2012 · 7 comments

Comments

Projects
None yet
3 participants

dmitris commented Nov 21, 2012

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)

Pull request added for the first five links. #32

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

@proverma proverma added a commit that referenced this issue Jan 22, 2013

@proverma proverma Merge pull request #32 from klamping/master
Fixed some of the incorrect hyperlinks listed in Issue #30
615dfca

dmitris commented Jan 22, 2013

Submitted #41 - but there's something strange about the way GitHub treats the internal link markup which differs from rst2html.py.

proverma commented Feb 5, 2013

can we close this bug now ?

@proverma proverma closed this Mar 8, 2013

dmitris commented Mar 12, 2013

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment