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-20832][docs] Deliver bootstrap css and js ourselves #14583

Merged
merged 6 commits into from
Jan 8, 2021

Conversation

wuchong
Copy link
Member

@wuchong wuchong commented Jan 8, 2021

What is the purpose of the change

Delivering the required files ourselves, instead of using a CDN to fix the unstable https://maxcdn.bootstrapcdn.com in China.

Brief change log

  • Copy the resource files into docs/page/...
  • Update the base.html.

Verifying this change

I shutdowned the network on my machine, and locally build the docs, and everything works well.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): (yes / no)
  • The public API, i.e., is any changed class annotated with @Public(Evolving): (yes / no)
  • The serializers: (yes / no / don't know)
  • The runtime per-record code paths (performance sensitive): (yes / no / don't know)
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: (yes / no / don't know)
  • The S3 file system connector: (yes / no / don't know)

Documentation

  • Does this pull request introduce a new feature? (yes / no)
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

@wuchong wuchong requested a review from rmetzger January 8, 2021 07:54
@flinkbot
Copy link
Collaborator

flinkbot commented Jan 8, 2021

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 4a04180 (Fri May 28 07:03:23 UTC 2021)

Warnings:

  • 1 pom.xml files were touched: Check for build and licensing issues.
  • 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

@rmetzger
Copy link
Contributor

rmetzger commented Jan 8, 2021

Thanks for opening the PR. Have you checked the licenses of the font files?

@wuchong
Copy link
Member Author

wuchong commented Jan 8, 2021

@rmetzger , no, I just download them from the bootstrap CDN url.
How do we deal with the existing docs/page/font-awesome/fonts/FontAwesome.otf?

@flinkbot
Copy link
Collaborator

flinkbot commented Jan 8, 2021

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run travis re-run the last Travis build
  • @flinkbot run azure re-run the last Azure build

@rmetzger
Copy link
Contributor

rmetzger commented Jan 8, 2021

It's mentioned in the /NOTICE file.

/*!
* Bootstrap v3.3.4 (http://getbootstrap.com)
* Copyright 2011-2015 Twitter, Inc.
* Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe we should mention this dependency in the NOTICE file and add a copy of the license to licenses/LICENSE.bootstrap.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure.

@wuchong
Copy link
Member Author

wuchong commented Jan 8, 2021

@rmetzger , I removed anchor.min.js because the website can be loaded even without this resource.

NOTICE Outdated Show resolved Hide resolved
@rmetzger
Copy link
Contributor

rmetzger commented Jan 8, 2021

@rmetzger , I removed anchor.min.js because the website can be loaded even without this resource.

But it seems that we are loading anchor.min.js from a cloudflare CDN.
I would ship the cloudflare files also like bootstrap ourselves.

wuchong and others added 3 commits January 8, 2021 16:47
Co-authored-by: Robert Metzger <89049+rmetzger@users.noreply.github.com>
@wuchong
Copy link
Member Author

wuchong commented Jan 8, 2021

@rmetzger I have added back the anchorjs

Copy link
Contributor

@rmetzger rmetzger left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for fixing this!

@wuchong wuchong merged commit af36844 into apache:master Jan 8, 2021
@wuchong wuchong deleted the fix-bootstrap branch January 8, 2021 14:29
wuchong added a commit to wuchong/flink that referenced this pull request Jan 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants