You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by mtunique <gi...@git.apache.org> on 2017/04/13 12:36:54 UTC

[GitHub] flink pull request #3720: [FLINK-6302] Documentation build error on ruby 2.4

GitHub user mtunique opened a pull request:

    https://github.com/apache/flink/pull/3720

    [FLINK-6302] Documentation build error on ruby 2.4

    Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration.
    If your changes take all of the items into account, feel free to open your pull request. For more information and/or questions please refer to the [How To Contribute guide](http://flink.apache.org/how-to-contribute.html).
    In addition to going through the list, please provide a meaningful description of your changes.
    
    - [x] General
      - The pull request references the related JIRA issue ("[FLINK-XXX] Jira title text")
      - The pull request addresses only one issue
      - Each commit in the PR has a meaningful commit message (including the JIRA id)
    
    - [ ] Documentation
      - Documentation has been added for new functionality
      - Old documentation affected by the pull request has been updated
      - JavaDoc for public methods has been added
    
    - [x] Tests & Build
      - Functionality added by the pull request is covered by tests
      - `mvn clean verify` has been executed successfully locally or a Travis build has passed


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

    $ git pull https://github.com/mtunique/flink FLINK-6302

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

    https://github.com/apache/flink/pull/3720.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 #3720
    
----
commit ef9dc01f6c7bccc4e74afd883b7fe9141bdadb79
Author: mtunique <oa...@gmail.com>
Date:   2017-04-13T12:22:41Z

    [FLINK-6302] Documentation build error on ruby 2.4

----


---
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] flink pull request #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:

    https://github.com/apache/flink/pull/3720#discussion_r113198925
  
    --- Diff: docs/Gemfile.lock ---
    @@ -30,18 +30,19 @@ GEM
           redcarpet (~> 3.1)
           safe_yaml (~> 1.0)
           toml (~> 0.1.0)
    -    jekyll-coffeescript (1.0.1)
    +    jekyll-coffeescript (1.0.2)
           coffee-script (~> 2.2)
    +      coffee-script-source (~> 1.11.1)
    --- End diff --
    
    For which jekyll version was that PR merged?


---
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] flink pull request #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:

    https://github.com/apache/flink/pull/3720#discussion_r113201398
  
    --- Diff: docs/Gemfile.lock ---
    @@ -30,18 +30,19 @@ GEM
           redcarpet (~> 3.1)
           safe_yaml (~> 1.0)
           toml (~> 0.1.0)
    -    jekyll-coffeescript (1.0.1)
    +    jekyll-coffeescript (1.0.2)
           coffee-script (~> 2.2)
    +      coffee-script-source (~> 1.11.1)
         jekyll-gist (1.4.0)
    -      octokit (~> 4.3.0)
    +      octokit (~> 4.2)
    --- End diff --
    
    Please revert this change; it worked before with 4.3.0 and this version is also referenced in other parts of the file.


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by haohui <gi...@git.apache.org>.
Github user haohui commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    I hit the same problem on my Mac. Let me try it out later today.


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by mtunique <gi...@git.apache.org>.
Github user mtunique commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    @StephanEwen I think it is the best way to solve this issue. I will follow the suggestion.


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by StephanEwen <gi...@git.apache.org>.
Github user StephanEwen commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    @alpinegizmo @zentol Now that #4043 is merged, can we rebase this one?


---
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] flink pull request #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:

    https://github.com/apache/flink/pull/3720#discussion_r113133585
  
    --- Diff: docs/Gemfile.lock ---
    @@ -30,18 +30,19 @@ GEM
           redcarpet (~> 3.1)
           safe_yaml (~> 1.0)
           toml (~> 0.1.0)
    -    jekyll-coffeescript (1.0.1)
    +    jekyll-coffeescript (1.0.2)
           coffee-script (~> 2.2)
    +      coffee-script-source (~> 1.11.1)
         jekyll-gist (1.4.0)
    -      octokit (~> 4.3.0)
    +      octokit (~> 4.2)
    --- End diff --
    
    Why are we downgrading a dependency?


---
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] flink pull request #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:

    https://github.com/apache/flink/pull/3720#discussion_r113133944
  
    --- Diff: docs/Gemfile.lock ---
    @@ -30,18 +30,19 @@ GEM
           redcarpet (~> 3.1)
           safe_yaml (~> 1.0)
           toml (~> 0.1.0)
    -    jekyll-coffeescript (1.0.1)
    +    jekyll-coffeescript (1.0.2)
           coffee-script (~> 2.2)
    +      coffee-script-source (~> 1.11.1)
    --- End diff --
    
    What's this about?


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    merging.


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by StephanEwen <gi...@git.apache.org>.
Github user StephanEwen commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    I am not familiar with the Ruby / Bundler / etc space, but it looks like `Gemfile` is the original source of truth and `Gemfile.lock` is in some way derived from that.
    Is it correct to only update `Gemfile.lock` and not `Gemfile`?
    
    @uce or @alpinegizmo can you maybe shed some light here?


---
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] flink pull request #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:

    https://github.com/apache/flink/pull/3720#discussion_r113292688
  
    --- Diff: docs/Gemfile.lock ---
    @@ -30,18 +30,19 @@ GEM
           redcarpet (~> 3.1)
           safe_yaml (~> 1.0)
           toml (~> 0.1.0)
    -    jekyll-coffeescript (1.0.1)
    +    jekyll-coffeescript (1.0.2)
           coffee-script (~> 2.2)
    +      coffee-script-source (~> 1.11.1)
         jekyll-gist (1.4.0)
    -      octokit (~> 4.3.0)
    +      octokit (~> 4.2)
    --- End diff --
    
    There was never an explicit version downgrade in `jekyll-gist`, they always had the `4.3.0` `octokit` dependency since it was added.
    
    Similarly, since we added the `jekyll-gist`/`octokit` dependency the version of `octokit` was set to `4.3.0`.
    
    In conclusion, it doesn't appear like it's related to a bug fix. We just always relied on a higher version than `jekyll-gist` did, and it worked out fine.


---
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] flink pull request #3720: [FLINK-6302] Documentation build error on ruby 2.4

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

    https://github.com/apache/flink/pull/3720


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by StephanEwen <gi...@git.apache.org>.
Github user StephanEwen commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    Would be great if someone else could confirm that this works. Ideally, we get a +1 from a Linux user, a MacOS X user, and a Cygwin user...


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by StephanEwen <gi...@git.apache.org>.
Github user StephanEwen commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    @mtunique What do you think about @alpinegizmo 's suggestion?


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by alpinegizmo <gi...@git.apache.org>.
Github user alpinegizmo commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    Yes, let's get this done.
    
    On Jun 6, 2017 19:03, "Stephan Ewen" <no...@github.com> wrote:
    
    > @alpinegizmo <https://github.com/alpinegizmo> @zentol
    > <https://github.com/zentol> Now that #4043
    > <https://github.com/apache/flink/pull/4043> is merged, can we rebase this
    > one?
    >
    > —
    > You are receiving this because you were mentioned.
    > Reply to this email directly, view it on GitHub
    > <https://github.com/apache/flink/pull/3720#issuecomment-306551741>, or mute
    > the thread
    > <https://github.com/notifications/unsubscribe-auth/AACqWFH4ZhNVBH2qCD6bsOrQaukYd3Dfks5sBYZKgaJpZM4M8pJW>
    > .
    >



---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by alpinegizmo <gi...@git.apache.org>.
Github user alpinegizmo commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    This looks good, thank you. However, I now understand what was going on with the downgrade of the octokit dependency. I think we should first merge https://github.com/apache/flink/pull/4043 and then rebase this PR. @zentol @StephanEwen 


---
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] flink pull request #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by mtunique <gi...@git.apache.org>.
Github user mtunique commented on a diff in the pull request:

    https://github.com/apache/flink/pull/3720#discussion_r113186880
  
    --- Diff: docs/Gemfile.lock ---
    @@ -30,18 +30,19 @@ GEM
           redcarpet (~> 3.1)
           safe_yaml (~> 1.0)
           toml (~> 0.1.0)
    -    jekyll-coffeescript (1.0.1)
    +    jekyll-coffeescript (1.0.2)
           coffee-script (~> 2.2)
    +      coffee-script-source (~> 1.11.1)
    --- End diff --
    
    I find [https://github.com/jekyll/jekyll/pull/5662](https://github.com/jekyll/jekyll/pull/5662), that PR add the dependency.


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    I can confirm that you can build the docs on W10 with the Linux Subsystem.


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by alpinegizmo <gi...@git.apache.org>.
Github user alpinegizmo commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    I prefer a conservative approach for as long as we still have to support building the docs on Ruby 1.9, so I'd keep the number of updated gems as small as possible.
    
    As for adding support for Ruby 2.4, both docs/Gemfile and docs/ruby2/Gemfile should be updated, along with their corresponding (and derived) Gemfile.lock files. Moreover, the octokit downgrade is not needed. 
    
    I'm not sure what motivates some of the proposed gem upgrades. I was able to get the docs to build on ruby 2.4 by making changing both Gemfiles as shown below. This leaves the classifier-reborn, ffi, libv8, posix-spawn, rb-inotify, redcarpet, and sass gems as they are rather than upgrading them. Do we need newer versions of any of those?
    
    -gem 'json'
    +gem 'json', '2.0.4'
    +gem 'yajl-ruby', '1.2.2'
    +gem 'jekyll-coffeescript', '1.0.2'
    
    With these upgrades, the build script still works for me on Ruby 1.9.3 and 2.3.3, as well as 2.4.0.


---
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] flink pull request #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by StephanEwen <gi...@git.apache.org>.
Github user StephanEwen commented on a diff in the pull request:

    https://github.com/apache/flink/pull/3720#discussion_r113273807
  
    --- Diff: docs/Gemfile.lock ---
    @@ -30,18 +30,19 @@ GEM
           redcarpet (~> 3.1)
           safe_yaml (~> 1.0)
           toml (~> 0.1.0)
    -    jekyll-coffeescript (1.0.1)
    +    jekyll-coffeescript (1.0.2)
           coffee-script (~> 2.2)
    +      coffee-script-source (~> 1.11.1)
         jekyll-gist (1.4.0)
    -      octokit (~> 4.3.0)
    +      octokit (~> 4.2)
    --- End diff --
    
    Does the downgrade fix an issue? If yes, its okay to do it, I think


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by haohui <gi...@git.apache.org>.
Github user haohui commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    +1 (non-binding)
    Tested on OSX Sierra. The documentation builds successfully.


---
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] flink pull request #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by mtunique <gi...@git.apache.org>.
Github user mtunique commented on a diff in the pull request:

    https://github.com/apache/flink/pull/3720#discussion_r113186869
  
    --- Diff: docs/Gemfile.lock ---
    @@ -30,18 +30,19 @@ GEM
           redcarpet (~> 3.1)
           safe_yaml (~> 1.0)
           toml (~> 0.1.0)
    -    jekyll-coffeescript (1.0.1)
    +    jekyll-coffeescript (1.0.2)
           coffee-script (~> 2.2)
    +      coffee-script-source (~> 1.11.1)
         jekyll-gist (1.4.0)
    -      octokit (~> 4.3.0)
    +      octokit (~> 4.2)
    --- End diff --
    
    [https://github.com/jekyll/jekyll-gist/blob/master/jekyll-gist.gemspec](https://github.com/jekyll/jekyll-gist/blob/master/jekyll-gist.gemspec) In that file octokit version is 4.2.   I am sorry about I don't have much knowledge about ruby, I don't know why it's 4.2 in previous.


---
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] flink issue #3720: [FLINK-6302] Documentation build error on ruby 2.4

Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on the issue:

    https://github.com/apache/flink/pull/3720
  
    The `GemFile` should be updated as well. It would still work as long as the `GemFile.lock` file is present. If it deleted however the bundler would load the dependencies from `GemFile` and create a new `GemFile.lock`.


---
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.
---