Skip to content
New issue

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

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-13729][docs] update website generation dependencies #9442

Closed
wants to merge 4 commits into from

Conversation

NicoK
Copy link
Contributor

@NicoK NicoK commented Aug 14, 2019

What is the purpose of the change

The website generation dependencies are quite old. By upgrading some of them we get improvements like a much nicer code highlighting and prepare for the jekyll update of FLINK-13726 and FLINK-13727.

Next PR in this series: #9443

Brief change log

Building on top of #9441, this PR adds:

  • update these to the newest versions:
    • addressable
    • octokit
    • therubyracer
    • json

Verifying this change

This change is a trivial rework and I verified the changes in the generated HTML pages. So far, I only saw changes/improvements in the syntax highlighting, e.g. non-primitive Java types also being highlighted.

@flinkbot
Copy link
Collaborator

flinkbot commented Aug 14, 2019

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit afe9d31 (Mon Aug 26 08:25:45 UTC 2019)

Warnings:

  • No documentation files were touched! Remember to keep the Flink docs up to date!

Mention the bot in a comment to re-run the automated checks.

Review Progress

  • ❓ 1. The [description] looks good.
  • ❓ 2. There is [consensus] that the contribution should go into to Flink.
  • ❓ 3. Needs [attention] from.
  • ❓ 4. The change fits into the overall [architecture].
  • ❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.


The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required Bot commands
The @flinkbot bot supports the following commands:

  • @flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
  • @flinkbot approve all to approve all aspects
  • @flinkbot approve-until architecture to approve everything until architecture
  • @flinkbot attention @username1 [@username2 ..] to require somebody's attention
  • @flinkbot disapprove architecture to remove an approval you gave earlier

…pages

Starting command tags with "{%-" will drop all whitespace to the left and ending
with "-%}" will drop all whitespace to the right (including newlines!).
Code like the following would otherwise create quite some unnecessary
whitespace:

  {% if parent_id %}
    {% assign parent_id = current[0].nav-parent_id %}
  {% else %}
    {% break %}
  {% endif %}
Jekyll requires liquid and only optionally uses liquid-c if available. The
latter uses natively-compiled code and reduces generation time by ~5% for me.
This seems to come with a much nicer code highlighting.
@flinkbot
Copy link
Collaborator

flinkbot commented Aug 14, 2019

CI report:

@zentol
Copy link
Contributor

zentol commented Aug 15, 2019

have we verified in any way whether all these changes work in the buildbot environment we're using?

@NicoK
Copy link
Contributor Author

NicoK commented Aug 15, 2019

What do you mean? How would I test this? https://cwiki.apache.org/confluence/display/FLINK/Managing+Flink+Documentation ?
I could let travis build it once to verify (doc building seems to be a cron task now and not covered by the PR tests) but that's probably not what you mean.

The dependencies are managed by bundler though - I guess, the only thing affecting the build process may be the installed ruby version where jekyll 4 requires ruby 2.4, but that's not in this PR

StephanEwen pushed a commit to StephanEwen/flink that referenced this pull request Aug 23, 2019
This seems to come with a much nicer code highlighting.

This closes apache#9442
@asfgit asfgit closed this in ef74a61 Aug 26, 2019
NicoK added a commit that referenced this pull request Nov 14, 2019
This seems to come with a much nicer code highlighting.

This closes #9442
NicoK added a commit that referenced this pull request Nov 14, 2019
This seems to come with a much nicer code highlighting.

This closes #9442
NicoK added a commit that referenced this pull request Nov 14, 2019
This seems to come with a much nicer code highlighting.

This closes #9442
NicoK added a commit that referenced this pull request Nov 14, 2019
This seems to come with a much nicer code highlighting.

This closes #9442
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants