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 2016/08/18 17:39:20 UTC
[GitHub] flink pull request #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
GitHub user uce opened a pull request:
https://github.com/apache/flink/pull/2387
[FLINK-4317, FLIP-3] [docs] Restructure docs
This is the initial layout for the docs restructuring as discussed in FLIP-3.
We move the top level navigation to the left side and allow arbitrary nestings to be defined. The main goal is that users find more of the important content. Therefore the docs are now treating streaming as the default and move some streaming-only content to the top-level.
This kind of left-side navigation layout is also followed by other popular projects like [Google DataFlow docs](https://cloud.google.com/dataflow/docs/) or http://readthedocs.org.
You can preview the new layout here: http://uce.github.io/flink/
We need to follow up with more actual content (see FLIP-3). If we adapt this layout, I would file the required content changes as JIRAs and ask someone to coordinate the writing process among the interested contributors.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/uce/flink docs
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/2387.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 #2387
----
commit 724296b0376291e7f4a0e4031507f871f56395fa
Author: Ufuk Celebi <uc...@apache.org>
Date: 2016-08-17T13:06:04Z
[FLINK-4317, FLIP-3] [docs] Restructure docs
- Add redirect layout
- Remove Maven artifact name warning
- Add info box if stable, but not latest
- Add font-awesome 4.6.3
- Add sidenav layout
----
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by rmetzger <gi...@git.apache.org>.
Github user rmetzger commented on the issue:
https://github.com/apache/flink/pull/2387
Where are the streaming connectors linked?
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by uce <gi...@git.apache.org>.
Github user uce commented on the issue:
https://github.com/apache/flink/pull/2387
I've addressed @aljoscha's and @jgrier's comments. @tillrohrmann I could not figure out how to do the centering in a different way, but I'm sure we (someone with more CSS skills) can address this as a follow up.
Since this is quite a major change, I would like to wait a little longer to get some more feedback. The question whether to merge this for 1.1 is open, too.
@greghogan @vasia Are you OK with the way Gelly is linked?
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by tillrohrmann <gi...@git.apache.org>.
Github user tillrohrmann commented on the issue:
https://github.com/apache/flink/pull/2387
Cool changes @uce. I really like them. I was wondering whether we should center the content pane instead of the content pane + navigation menu.
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by greghogan <gi...@git.apache.org>.
Github user greghogan commented on the issue:
https://github.com/apache/flink/pull/2387
@uce this looks very nice, and navigating libraries is much improved with the extra level(s?) of navigation.
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by uce <gi...@git.apache.org>.
Github user uce commented on the issue:
https://github.com/apache/flink/pull/2387
@aljoscha I will add some text to the overview pages.
@tillrohrmann I will check out whether I can do it. It's certainly possible to do it, but we might need to do it as a follow up if I can't get it done in a reasonable amount of time. ;)
Would you like to also merge this for 1.1? If yes, I would add redirects for links that have changed.
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/flink/pull/2387
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by StephanEwen <gi...@git.apache.org>.
Github user StephanEwen commented on the issue:
https://github.com/apache/flink/pull/2387
+1 to merge this.
Merging it for 1.2 makes more sense to me.
Having it for 1.2-SNAPSHOT makes this already accessible for users and we don't mess up patching the 1.1 docs.
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by uce <gi...@git.apache.org>.
Github user uce commented on the issue:
https://github.com/apache/flink/pull/2387
That was a bug. Fixed and updated preview. It's found under `Application Development` on the same level as `State Backends` etc.
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by rmetzger <gi...@git.apache.org>.
Github user rmetzger commented on the issue:
https://github.com/apache/flink/pull/2387
I'm against merging it to the 1.1.x branch. Its a big change, that we would do between releases.
In a few months, we'll have a new release, then users can enjoy the new layout.
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by rmetzger <gi...@git.apache.org>.
Github user rmetzger commented on the issue:
https://github.com/apache/flink/pull/2387
Great, thank you.
+1 to merge :)
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by uce <gi...@git.apache.org>.
Github user uce commented on the issue:
https://github.com/apache/flink/pull/2387
Yes, we still have to add content for the overview pages, in that case `apis.md`.
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by jgrier <gi...@git.apache.org>.
Github user jgrier commented on the issue:
https://github.com/apache/flink/pull/2387
This looks great! I really like the left side navigation. I think this is a big improvement.
One suggestion: Can we change the name of the "Testing & Debugging" section to something like "Monitoring and Debugging"?. Most of what's in that section is about monitoring.
---
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 #2387: [FLINK-4317, FLIP-3] [docs] Restructure docs
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha commented on the issue:
https://github.com/apache/flink/pull/2387
I really like the new look/structure. \U0001f44d
What's strange is that when I click the breadcrumb links, I get an empty page. For example if I click "API" here:
<img width="878" alt="screen shot 2016-08-19 at 09 39 03" src="https://cloud.githubusercontent.com/assets/68551/17802489/e29907b6-65f0-11e6-9206-0aeca5c06af8.png">
---
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.
---