You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@brooklyn.apache.org by sjcorbett <gi...@git.apache.org> on 2015/01/07 15:02:41 UTC

[GitHub] incubator-brooklyn pull request: Documentation link check improvem...

GitHub user sjcorbett opened a pull request:

    https://github.com/apache/incubator-brooklyn/pull/438

    Documentation link check improvements

    Swaps the link-checker gem for html-proofer, which can check [quite a lot more](https://github.com/gjtorikian/html-proofer#whats-tested). Incorporated the tool into `build.sh` and added option t skip with `--skip-tests`.
    
    Also replaces all uses of "brooklyn" with "Brooklyn".

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/sjcorbett/incubator-brooklyn doc

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/incubator-brooklyn/pull/438.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #438
    
----
commit 0810fe02aedb6b868aeafff586c34f1aad1c1a52
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Date:   2015-01-07T11:57:19Z

    Docs: Swaps link-checker gem for html-proofer
    
    Incorporated into build.sh. Skip with --skip-tests

commit 1f0f04822e40cc57b12714a6bf57b3bfa0b2c3ee
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Date:   2015-01-07T12:57:35Z

    Fix a number of broken links

commit f006727d2a55b83e376e4f72579fda89126033eb
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Date:   2015-01-07T13:17:07Z

    Brooklyn, not brooklyn

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-brooklyn pull request: Documentation link check improvem...

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

    https://github.com/apache/incubator-brooklyn/pull/438


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-brooklyn pull request: Documentation link check improvem...

Posted by sjcorbett <gi...@git.apache.org>.
Github user sjcorbett commented on the pull request:

    https://github.com/apache/incubator-brooklyn/pull/438#issuecomment-69353943
  
    Replaces brooklyn with Brooklyn comment no longer valid as subsequent merged pull requests cause a whole lot of conflicts.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-brooklyn pull request: Documentation link check improvem...

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/incubator-brooklyn/pull/438#issuecomment-69393683
  
    fixed with `bundle config build.nokogiri --use-system-libraries` as per http://www.nokogiri.org/tutorials/installing_nokogiri.html



---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-brooklyn pull request: Documentation link check improvem...

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/incubator-brooklyn/pull/438#issuecomment-69391868
  
    thanks for the warning
    
    i like the idea of this
    
    unfortunately it has lead (for me) to ruby dependency hell; `bundle install` seemed to work, but then running gave:
    
        dyld: lazy symbol binding failed: Symbol not found: _rb_funcall2
    
    i then tried the instructions [here](http://judykat.com/ken-judy/force-bundler-rebuild-ruby-rails-gemset/) to cleanly reinstall the gems but now installing nokogiri is giving:
    
        libxml2 is missing.  Please locate mkmf.log to investigate how it is failing.
    
    i'm testing tips [here](http://www.nokogiri.org/tutorials/installing_nokogiri.html) and [here](http://stackoverflow.com/questions/5528839/why-does-installing-nokogiri-on-mac-os-fail-with-libiconv-is-missing#comment30773476_6163052) but if you have any quick tips let me know


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-brooklyn pull request: Documentation link check improvem...

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/incubator-brooklyn/pull/438#issuecomment-69394196
  
    this is *so* useful!
    
    it would be good to configure it to ignore some "problems":
    * `anchor has no href attribute` (that's allowed, if you want to link to it, isn't it?)
    * `External link http://127.0.0.1:8081 failed: got a time out` (ha!)
    * links to other versions (we could work around that by creating mocks)
    
    but it's all just informational (doesn't fail the build) so we can merge as is i think
    
    i'll do a bunch more cleanup based on the output of this (in a separate PR); it will make the docs setup much nicer -- great addition.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-brooklyn pull request: Documentation link check improvem...

Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:

    https://github.com/apache/incubator-brooklyn/pull/438#issuecomment-69359491
  
    awesome!  let me try this before i update the web site (tonight)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-brooklyn pull request: Documentation link check improvem...

Posted by sjcorbett <gi...@git.apache.org>.
Github user sjcorbett commented on the pull request:

    https://github.com/apache/incubator-brooklyn/pull/438#issuecomment-69359942
  
    Just a warning that you'll get _a lot_ of warnings! It's worth considering whether we want the tool enabled by default.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---