You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by uce <gi...@git.apache.org> on 2017/08/16 16:47:00 UTC
[GitHub] flink pull request #4553: [FLINK-7642] [docs] Add very obvious warning about...
GitHub user uce opened a pull request:
https://github.com/apache/flink/pull/4553
[FLINK-7642] [docs] Add very obvious warning about outdated docs
## What is the purpose of the change
This pull requests make the warning about outdated docs more obvious.
Please compare the screenshot to our current state: https://ci.apache.org/projects/flink/flink-docs-release-1.1/
If you like this, I would back/forward port this to all versions >= 1.0 and update the releasing Wiki page to add a note about updating the configuration of the docs.
## Brief change log
- Change the color of the outdated warning footer to red
- Rename the config key from `is_latest` to `show_outdated_warning`
- Add an outdated warning to every page before the actual content
## Verifying this change
- We don't have any tests for the docs
- You can manually check out my branch and build the docs
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/uce/flink 7462-outdated_docs_warning
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/4553.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 #4553
----
commit e140634687a56fb5fdd0e32a1dce3d5ac41fd123
Author: Ufuk Celebi <uc...@apache.org>
Date: 2017-08-16T16:21:49Z
[FLINK-7462] [docs] Make outdated docs footer background light red
commit 15fe71e0402d2e2d931485497338973e12cce9db
Author: Ufuk Celebi <uc...@apache.org>
Date: 2017-08-16T16:34:51Z
[FLINK-7462] [docs] Rename is_latest flag to show_outdated_warning
commit 9bdeeae0cb88b59f0dfaee547fbf9b54d125645e
Author: Ufuk Celebi <uc...@apache.org>
Date: 2017-08-16T16:35:03Z
[FLINK-7462] [docs] Add outdated warning to content
----
---
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 #4553: [FLINK-7642] [docs] Add very obvious warning about outdat...
Posted by uce <gi...@git.apache.org>.
Github user uce commented on the issue:
https://github.com/apache/flink/pull/4553
@twalthr Thanks for doing the work of merging this to the other branches as well. I've triggered a build for all branches. While 1.2 worked and the warning is now available online (https://ci.apache.org/projects/flink/flink-docs-release-1.2/), older branches don't build properly:
https://ci.apache.org/builders/flink-docs-release-1.0/builds/545
https://ci.apache.org/builders/flink-docs-release-1.1/builds/391
Do you have a clue what we can do there? Also pinging @rmetzger who has some experience with the Apache infrastructure...
---
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 #4553: [FLINK-7642] [docs] Add very obvious warning about outdat...
Posted by twalthr <gi...@git.apache.org>.
Github user twalthr commented on the issue:
https://github.com/apache/flink/pull/4553
I merge this to all release branches >= 1.0. Feel free to check if I didn't make a mistake.
---
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 #4553: [FLINK-7642] [docs] Add very obvious warning about outdat...
Posted by rmetzger <gi...@git.apache.org>.
Github user rmetzger commented on the issue:
https://github.com/apache/flink/pull/4553
Afaik the problem is that the doc builders are independent of Flink version. So we use the same toolchain for building 0.8 docs and 1.4 docs.
The `flink.conf` file in https://svn.apache.org/repos/infra/infrastructure/buildbot/aegis/buildmaster/master1/projects contains the builder config. I've introduced @twalthr into the ugly details of it a few weeks ago, maybe he can look into it.
---
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 #4553: [FLINK-7642] [docs] Add very obvious warning about...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/flink/pull/4553
---
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 #4553: [FLINK-7642] [docs] Add very obvious warning about outdat...
Posted by twalthr <gi...@git.apache.org>.
Github user twalthr commented on the issue:
https://github.com/apache/flink/pull/4553
+1 Thank you @uce. I will merge this...
---
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 #4553: [FLINK-7642] [docs] Add very obvious warning about outdat...
Posted by alpinegizmo <gi...@git.apache.org>.
Github user alpinegizmo commented on the issue:
https://github.com/apache/flink/pull/4553
+1 I like these improvements.
---
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.
---