-
Notifications
You must be signed in to change notification settings - Fork 13.3k
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
Conversation
Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community Automated ChecksLast check on commit afe9d31 (Mon Aug 26 08:25:45 UTC 2019) Warnings:
Mention the bot in a comment to re-run the automated checks. Review Progress
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 commandsThe @flinkbot bot supports the following commands:
|
…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.
have we verified in any way whether all these changes work in the buildbot environment we're using? |
What do you mean? How would I test this? https://cwiki.apache.org/confluence/display/FLINK/Managing+Flink+Documentation ? 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 |
This seems to come with a much nicer code highlighting. This closes apache#9442
This seems to come with a much nicer code highlighting. This closes #9442
This seems to come with a much nicer code highlighting. This closes #9442
This seems to come with a much nicer code highlighting. This closes #9442
This seems to come with a much nicer code highlighting. This closes #9442
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:
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.